diff --git a/doc/config/_default/config.toml b/doc/config/_default/config.toml index b4abcd1252..59df7f5d24 100644 --- a/doc/config/_default/config.toml +++ b/doc/config/_default/config.toml @@ -23,7 +23,7 @@ pygmentsUseClasses = true github_repository = "https://github.com/TheThingsIndustries/lorawan-stack-docs" github_repository_edit = "https://github.com/TheThingsIndustries/lorawan-stack-docs/blob/master/doc/content" tts_github_repository = "https://github.com/TheThingsNetwork/lorawan-stack" - version = "3.32.3" + version = "3.33.0" [markup] [markup.goldmark] diff --git a/doc/content/api/reference/grpc/user.md b/doc/content/api/reference/grpc/user.md index 20a2a2fa21..eb70906df9 100644 --- a/doc/content/api/reference/grpc/user.md +++ b/doc/content/api/reference/grpc/user.md @@ -114,6 +114,8 @@ List of User APIs. {{< proto/message package="tti.lorawan.v3" message="DeleteExternalUserRequest" >}} +{{< proto/message message="EmailNotificationPreferences" >}} + {{< proto/message message="EndDeviceIdentifiers" >}} {{< proto/message message="EntityIdentifiers" >}} @@ -182,6 +184,8 @@ List of User APIs. {{< proto/message message="UserConsolePreferences.SortBy" >}} +{{< proto/message message="UserConsolePreferences.Tutorials" >}} + {{< proto/message message="UserSessionIdentifiers" >}} ## Enums @@ -196,10 +200,14 @@ List of User APIs. {{< proto/enum enum="NotificationStatus" >}} +{{< proto/enum enum="NotificationType" >}} + {{< proto/enum enum="NotificationReceiver" >}} {{< proto/enum enum="Right" >}} {{< proto/enum enum="State" >}} +{{< proto/enum enum="Tutorial" >}} + {{< api-refs >}} diff --git a/doc/content/the-things-stack/host/aws/ecs/changelog/index.md b/doc/content/the-things-stack/host/aws/ecs/changelog/index.md index 83b5b34836..0da4848360 100644 --- a/doc/content/the-things-stack/host/aws/ecs/changelog/index.md +++ b/doc/content/the-things-stack/host/aws/ecs/changelog/index.md @@ -2,12 +2,17 @@ title: "Template Changelog" aliases: [/getting-started/aws/ecs/changelog] --- + # Upgrading All meaningful changes to templates are documented in this file. ## Unreleased +## 3.33.0 + +## 3.32.3 + - Add GRPC methods rate limiting metric to prometheus rules. ### Proxy diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_applications_api-keys_create.md b/doc/content/ttn-lw-cli/ttn-lw-cli_applications_api-keys_create.md index d803b5f91b..4d40b13221 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_applications_api-keys_create.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_applications_api-keys_create.md @@ -25,6 +25,7 @@ ttn-lw-cli applications api-keys create [application-id] [flags] --right-application-devices-write-keys --right-application-info --right-application-link + --right-application-purge --right-application-settings-api-keys --right-application-settings-basic --right-application-settings-collaborators diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_applications_api-keys_set.md b/doc/content/ttn-lw-cli/ttn-lw-cli_applications_api-keys_set.md index 3f74e55b2c..2ef950c10f 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_applications_api-keys_set.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_applications_api-keys_set.md @@ -26,6 +26,7 @@ ttn-lw-cli applications api-keys set [application-id] [api-key-id] [flags] --right-application-devices-write-keys --right-application-info --right-application-link + --right-application-purge --right-application-settings-api-keys --right-application-settings-basic --right-application-settings-collaborators diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_applications_collaborators_set.md b/doc/content/ttn-lw-cli/ttn-lw-cli_applications_collaborators_set.md index 003b678ba4..0ae5836d33 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_applications_collaborators_set.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_applications_collaborators_set.md @@ -24,6 +24,7 @@ ttn-lw-cli applications collaborators set [flags] --right-application-devices-write-keys --right-application-info --right-application-link + --right-application-purge --right-application-settings-api-keys --right-application-settings-basic --right-application-settings-collaborators diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_clients_collaborators_set.md b/doc/content/ttn-lw-cli/ttn-lw-cli_clients_collaborators_set.md index 9d0593c774..c29a110162 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_clients_collaborators_set.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_clients_collaborators_set.md @@ -19,6 +19,7 @@ ttn-lw-cli clients collaborators set [flags] --right-client-all --right-client-delete --right-client-info + --right-client-purge --right-client-settings-basic --right-client-settings-collaborators --user-id string diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_clients_create.md b/doc/content/ttn-lw-cli/ttn-lw-cli_clients_create.md index 75485919e8..28446ce908 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_clients_create.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_clients_create.md @@ -26,7 +26,7 @@ ttn-lw-cli clients create [client-id] [flags] --name string --organization-id string --redirect-uris strings - --rights strings allowed values: right_invalid, RIGHT_USER_INFO, RIGHT_USER_SETTINGS_BASIC, RIGHT_USER_SETTINGS_API_KEYS, RIGHT_USER_DELETE, RIGHT_USER_AUTHORIZED_CLIENTS, RIGHT_USER_APPLICATIONS_LIST, RIGHT_USER_APPLICATIONS_CREATE, RIGHT_USER_GATEWAYS_LIST, RIGHT_USER_GATEWAYS_CREATE, RIGHT_USER_CLIENTS_LIST, RIGHT_USER_CLIENTS_CREATE, RIGHT_USER_ORGANIZATIONS_LIST, RIGHT_USER_ORGANIZATIONS_CREATE, RIGHT_USER_ALL, RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_SETTINGS_BASIC, RIGHT_APPLICATION_SETTINGS_API_KEYS, RIGHT_APPLICATION_SETTINGS_COLLABORATORS, RIGHT_APPLICATION_DELETE, RIGHT_APPLICATION_DEVICES_READ, RIGHT_APPLICATION_DEVICES_WRITE, RIGHT_APPLICATION_DEVICES_READ_KEYS, RIGHT_APPLICATION_DEVICES_WRITE_KEYS, RIGHT_APPLICATION_TRAFFIC_READ, RIGHT_APPLICATION_TRAFFIC_UP_WRITE, RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE, RIGHT_APPLICATION_LINK, RIGHT_APPLICATION_ALL, RIGHT_CLIENT_ALL, RIGHT_GATEWAY_INFO, RIGHT_GATEWAY_SETTINGS_BASIC, RIGHT_GATEWAY_SETTINGS_API_KEYS, RIGHT_GATEWAY_SETTINGS_COLLABORATORS, RIGHT_GATEWAY_DELETE, RIGHT_GATEWAY_TRAFFIC_READ, RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE, RIGHT_GATEWAY_LINK, RIGHT_GATEWAY_STATUS_READ, RIGHT_GATEWAY_LOCATION_READ, RIGHT_GATEWAY_ALL, RIGHT_ORGANIZATION_INFO, RIGHT_ORGANIZATION_SETTINGS_BASIC, RIGHT_ORGANIZATION_SETTINGS_API_KEYS, RIGHT_ORGANIZATION_SETTINGS_MEMBERS, RIGHT_ORGANIZATION_DELETE, RIGHT_ORGANIZATION_APPLICATIONS_LIST, RIGHT_ORGANIZATION_APPLICATIONS_CREATE, RIGHT_ORGANIZATION_GATEWAYS_LIST, RIGHT_ORGANIZATION_GATEWAYS_CREATE, RIGHT_ORGANIZATION_CLIENTS_LIST, RIGHT_ORGANIZATION_CLIENTS_CREATE, RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR, RIGHT_ORGANIZATION_ALL, RIGHT_SEND_INVITES, RIGHT_ALL, RIGHT_APPLICATION_SETTINGS_PACKAGES, RIGHT_GATEWAY_WRITE_SECRETS, RIGHT_GATEWAY_READ_SECRETS, RIGHT_USER_NOTIFICATIONS_READ, RIGHT_CLIENT_INFO, RIGHT_CLIENT_SETTINGS_BASIC, RIGHT_CLIENT_SETTINGS_COLLABORATORS, RIGHT_CLIENT_DELETE + --rights strings allowed values: right_invalid, RIGHT_USER_INFO, RIGHT_USER_SETTINGS_BASIC, RIGHT_USER_SETTINGS_API_KEYS, RIGHT_USER_DELETE, RIGHT_USER_AUTHORIZED_CLIENTS, RIGHT_USER_APPLICATIONS_LIST, RIGHT_USER_APPLICATIONS_CREATE, RIGHT_USER_GATEWAYS_LIST, RIGHT_USER_GATEWAYS_CREATE, RIGHT_USER_CLIENTS_LIST, RIGHT_USER_CLIENTS_CREATE, RIGHT_USER_ORGANIZATIONS_LIST, RIGHT_USER_ORGANIZATIONS_CREATE, RIGHT_USER_ALL, RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_SETTINGS_BASIC, RIGHT_APPLICATION_SETTINGS_API_KEYS, RIGHT_APPLICATION_SETTINGS_COLLABORATORS, RIGHT_APPLICATION_DELETE, RIGHT_APPLICATION_DEVICES_READ, RIGHT_APPLICATION_DEVICES_WRITE, RIGHT_APPLICATION_DEVICES_READ_KEYS, RIGHT_APPLICATION_DEVICES_WRITE_KEYS, RIGHT_APPLICATION_TRAFFIC_READ, RIGHT_APPLICATION_TRAFFIC_UP_WRITE, RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE, RIGHT_APPLICATION_LINK, RIGHT_APPLICATION_ALL, RIGHT_CLIENT_ALL, RIGHT_GATEWAY_INFO, RIGHT_GATEWAY_SETTINGS_BASIC, RIGHT_GATEWAY_SETTINGS_API_KEYS, RIGHT_GATEWAY_SETTINGS_COLLABORATORS, RIGHT_GATEWAY_DELETE, RIGHT_GATEWAY_TRAFFIC_READ, RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE, RIGHT_GATEWAY_LINK, RIGHT_GATEWAY_STATUS_READ, RIGHT_GATEWAY_LOCATION_READ, RIGHT_GATEWAY_ALL, RIGHT_ORGANIZATION_INFO, RIGHT_ORGANIZATION_SETTINGS_BASIC, RIGHT_ORGANIZATION_SETTINGS_API_KEYS, RIGHT_ORGANIZATION_SETTINGS_MEMBERS, RIGHT_ORGANIZATION_DELETE, RIGHT_ORGANIZATION_APPLICATIONS_LIST, RIGHT_ORGANIZATION_APPLICATIONS_CREATE, RIGHT_ORGANIZATION_GATEWAYS_LIST, RIGHT_ORGANIZATION_GATEWAYS_CREATE, RIGHT_ORGANIZATION_CLIENTS_LIST, RIGHT_ORGANIZATION_CLIENTS_CREATE, RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR, RIGHT_ORGANIZATION_ALL, RIGHT_SEND_INVITES, RIGHT_ALL, RIGHT_APPLICATION_SETTINGS_PACKAGES, RIGHT_GATEWAY_WRITE_SECRETS, RIGHT_GATEWAY_READ_SECRETS, RIGHT_USER_NOTIFICATIONS_READ, RIGHT_CLIENT_INFO, RIGHT_CLIENT_SETTINGS_BASIC, RIGHT_CLIENT_SETTINGS_COLLABORATORS, RIGHT_CLIENT_DELETE, RIGHT_APPLICATION_PURGE, RIGHT_ORGANIZATION_PURGE, RIGHT_USER_PURGE, RIGHT_GATEWAY_PURGE, RIGHT_CLIENT_PURGE, RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE, RIGHT_ALERT_NOTIFICATION_PROFILE_INFO, RIGHT_ALERT_NOTIFICATION_PROFILE_LIST, RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE, RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE, RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE, RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO, RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST, RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE, RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE, RIGHT_AUTHENTICATION_PROVIDER_CREATE, RIGHT_AUTHENTICATION_PROVIDER_INFO, RIGHT_AUTHENTICATION_PROVIDER_LIST, RIGHT_AUTHENTICATION_PROVIDER_UPDATE, RIGHT_AUTHENTICATION_PROVIDER_DELETE, RIGHT_EXTERNAL_USER_CREATE, RIGHT_EXTERNAL_USER_INFO, RIGHT_EXTERNAL_USER_DELETE, RIGHT_USER_LIST, RIGHT_USER_CREATE, RIGHT_PACKET_BROKER_AGENT_READ, RIGHT_PACKET_BROKER_AGENT_WRITE, RIGHT_TENANT_CONFIGURATION_UPDATE --secret string --skip-authorization --state string allowed values: STATE_REQUESTED, STATE_APPROVED, STATE_REJECTED, STATE_FLAGGED, STATE_SUSPENDED diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_clients_set.md b/doc/content/ttn-lw-cli/ttn-lw-cli_clients_set.md index f2513b3628..25e878ab96 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_clients_set.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_clients_set.md @@ -25,7 +25,7 @@ ttn-lw-cli clients set [client-id] [flags] --logout-redirect-uris strings --name string --redirect-uris strings - --rights strings allowed values: right_invalid, RIGHT_USER_INFO, RIGHT_USER_SETTINGS_BASIC, RIGHT_USER_SETTINGS_API_KEYS, RIGHT_USER_DELETE, RIGHT_USER_AUTHORIZED_CLIENTS, RIGHT_USER_APPLICATIONS_LIST, RIGHT_USER_APPLICATIONS_CREATE, RIGHT_USER_GATEWAYS_LIST, RIGHT_USER_GATEWAYS_CREATE, RIGHT_USER_CLIENTS_LIST, RIGHT_USER_CLIENTS_CREATE, RIGHT_USER_ORGANIZATIONS_LIST, RIGHT_USER_ORGANIZATIONS_CREATE, RIGHT_USER_ALL, RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_SETTINGS_BASIC, RIGHT_APPLICATION_SETTINGS_API_KEYS, RIGHT_APPLICATION_SETTINGS_COLLABORATORS, RIGHT_APPLICATION_DELETE, RIGHT_APPLICATION_DEVICES_READ, RIGHT_APPLICATION_DEVICES_WRITE, RIGHT_APPLICATION_DEVICES_READ_KEYS, RIGHT_APPLICATION_DEVICES_WRITE_KEYS, RIGHT_APPLICATION_TRAFFIC_READ, RIGHT_APPLICATION_TRAFFIC_UP_WRITE, RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE, RIGHT_APPLICATION_LINK, RIGHT_APPLICATION_ALL, RIGHT_CLIENT_ALL, RIGHT_GATEWAY_INFO, RIGHT_GATEWAY_SETTINGS_BASIC, RIGHT_GATEWAY_SETTINGS_API_KEYS, RIGHT_GATEWAY_SETTINGS_COLLABORATORS, RIGHT_GATEWAY_DELETE, RIGHT_GATEWAY_TRAFFIC_READ, RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE, RIGHT_GATEWAY_LINK, RIGHT_GATEWAY_STATUS_READ, RIGHT_GATEWAY_LOCATION_READ, RIGHT_GATEWAY_ALL, RIGHT_ORGANIZATION_INFO, RIGHT_ORGANIZATION_SETTINGS_BASIC, RIGHT_ORGANIZATION_SETTINGS_API_KEYS, RIGHT_ORGANIZATION_SETTINGS_MEMBERS, RIGHT_ORGANIZATION_DELETE, RIGHT_ORGANIZATION_APPLICATIONS_LIST, RIGHT_ORGANIZATION_APPLICATIONS_CREATE, RIGHT_ORGANIZATION_GATEWAYS_LIST, RIGHT_ORGANIZATION_GATEWAYS_CREATE, RIGHT_ORGANIZATION_CLIENTS_LIST, RIGHT_ORGANIZATION_CLIENTS_CREATE, RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR, RIGHT_ORGANIZATION_ALL, RIGHT_SEND_INVITES, RIGHT_ALL, RIGHT_APPLICATION_SETTINGS_PACKAGES, RIGHT_GATEWAY_WRITE_SECRETS, RIGHT_GATEWAY_READ_SECRETS, RIGHT_USER_NOTIFICATIONS_READ, RIGHT_CLIENT_INFO, RIGHT_CLIENT_SETTINGS_BASIC, RIGHT_CLIENT_SETTINGS_COLLABORATORS, RIGHT_CLIENT_DELETE + --rights strings allowed values: right_invalid, RIGHT_USER_INFO, RIGHT_USER_SETTINGS_BASIC, RIGHT_USER_SETTINGS_API_KEYS, RIGHT_USER_DELETE, RIGHT_USER_AUTHORIZED_CLIENTS, RIGHT_USER_APPLICATIONS_LIST, RIGHT_USER_APPLICATIONS_CREATE, RIGHT_USER_GATEWAYS_LIST, RIGHT_USER_GATEWAYS_CREATE, RIGHT_USER_CLIENTS_LIST, RIGHT_USER_CLIENTS_CREATE, RIGHT_USER_ORGANIZATIONS_LIST, RIGHT_USER_ORGANIZATIONS_CREATE, RIGHT_USER_ALL, RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_SETTINGS_BASIC, RIGHT_APPLICATION_SETTINGS_API_KEYS, RIGHT_APPLICATION_SETTINGS_COLLABORATORS, RIGHT_APPLICATION_DELETE, RIGHT_APPLICATION_DEVICES_READ, RIGHT_APPLICATION_DEVICES_WRITE, RIGHT_APPLICATION_DEVICES_READ_KEYS, RIGHT_APPLICATION_DEVICES_WRITE_KEYS, RIGHT_APPLICATION_TRAFFIC_READ, RIGHT_APPLICATION_TRAFFIC_UP_WRITE, RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE, RIGHT_APPLICATION_LINK, RIGHT_APPLICATION_ALL, RIGHT_CLIENT_ALL, RIGHT_GATEWAY_INFO, RIGHT_GATEWAY_SETTINGS_BASIC, RIGHT_GATEWAY_SETTINGS_API_KEYS, RIGHT_GATEWAY_SETTINGS_COLLABORATORS, RIGHT_GATEWAY_DELETE, RIGHT_GATEWAY_TRAFFIC_READ, RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE, RIGHT_GATEWAY_LINK, RIGHT_GATEWAY_STATUS_READ, RIGHT_GATEWAY_LOCATION_READ, RIGHT_GATEWAY_ALL, RIGHT_ORGANIZATION_INFO, RIGHT_ORGANIZATION_SETTINGS_BASIC, RIGHT_ORGANIZATION_SETTINGS_API_KEYS, RIGHT_ORGANIZATION_SETTINGS_MEMBERS, RIGHT_ORGANIZATION_DELETE, RIGHT_ORGANIZATION_APPLICATIONS_LIST, RIGHT_ORGANIZATION_APPLICATIONS_CREATE, RIGHT_ORGANIZATION_GATEWAYS_LIST, RIGHT_ORGANIZATION_GATEWAYS_CREATE, RIGHT_ORGANIZATION_CLIENTS_LIST, RIGHT_ORGANIZATION_CLIENTS_CREATE, RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR, RIGHT_ORGANIZATION_ALL, RIGHT_SEND_INVITES, RIGHT_ALL, RIGHT_APPLICATION_SETTINGS_PACKAGES, RIGHT_GATEWAY_WRITE_SECRETS, RIGHT_GATEWAY_READ_SECRETS, RIGHT_USER_NOTIFICATIONS_READ, RIGHT_CLIENT_INFO, RIGHT_CLIENT_SETTINGS_BASIC, RIGHT_CLIENT_SETTINGS_COLLABORATORS, RIGHT_CLIENT_DELETE, RIGHT_APPLICATION_PURGE, RIGHT_ORGANIZATION_PURGE, RIGHT_USER_PURGE, RIGHT_GATEWAY_PURGE, RIGHT_CLIENT_PURGE, RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE, RIGHT_ALERT_NOTIFICATION_PROFILE_INFO, RIGHT_ALERT_NOTIFICATION_PROFILE_LIST, RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE, RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE, RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE, RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO, RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST, RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE, RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE, RIGHT_AUTHENTICATION_PROVIDER_CREATE, RIGHT_AUTHENTICATION_PROVIDER_INFO, RIGHT_AUTHENTICATION_PROVIDER_LIST, RIGHT_AUTHENTICATION_PROVIDER_UPDATE, RIGHT_AUTHENTICATION_PROVIDER_DELETE, RIGHT_EXTERNAL_USER_CREATE, RIGHT_EXTERNAL_USER_INFO, RIGHT_EXTERNAL_USER_DELETE, RIGHT_USER_LIST, RIGHT_USER_CREATE, RIGHT_PACKET_BROKER_AGENT_READ, RIGHT_PACKET_BROKER_AGENT_WRITE, RIGHT_TENANT_CONFIGURATION_UPDATE --secret string --skip-authorization --state string allowed values: STATE_REQUESTED, STATE_APPROVED, STATE_REJECTED, STATE_FLAGGED, STATE_SUSPENDED diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_api-keys_create.md b/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_api-keys_create.md index 9a8ef05a81..d65ae3787e 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_api-keys_create.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_api-keys_create.md @@ -22,6 +22,7 @@ ttn-lw-cli gateways api-keys create [gateway-id] [flags] --right-gateway-info --right-gateway-link --right-gateway-location-read + --right-gateway-purge --right-gateway-read-secrets --right-gateway-settings-api-keys --right-gateway-settings-basic diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_api-keys_set.md b/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_api-keys_set.md index 9099c1734b..d320b1d4d3 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_api-keys_set.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_api-keys_set.md @@ -23,6 +23,7 @@ ttn-lw-cli gateways api-keys set [gateway-id] [api-key-id] [flags] --right-gateway-info --right-gateway-link --right-gateway-location-read + --right-gateway-purge --right-gateway-read-secrets --right-gateway-settings-api-keys --right-gateway-settings-basic diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_collaborators_set.md b/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_collaborators_set.md index 46094b8f42..f4623103cc 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_collaborators_set.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_collaborators_set.md @@ -21,6 +21,7 @@ ttn-lw-cli gateways collaborators set [flags] --right-gateway-info --right-gateway-link --right-gateway-location-read + --right-gateway-purge --right-gateway-read-secrets --right-gateway-settings-api-keys --right-gateway-settings-basic diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_organizations_api-keys_create.md b/doc/content/ttn-lw-cli/ttn-lw-cli_organizations_api-keys_create.md index 6339c2ac2f..1c227708f2 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_organizations_api-keys_create.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_organizations_api-keys_create.md @@ -25,6 +25,7 @@ ttn-lw-cli organizations api-keys create [organization-id] [flags] --right-application-devices-write-keys --right-application-info --right-application-link + --right-application-purge --right-application-settings-api-keys --right-application-settings-basic --right-application-settings-collaborators @@ -35,6 +36,7 @@ ttn-lw-cli organizations api-keys create [organization-id] [flags] --right-client-all --right-client-delete --right-client-info + --right-client-purge --right-client-settings-basic --right-client-settings-collaborators --right-gateway-all @@ -42,6 +44,7 @@ ttn-lw-cli organizations api-keys create [organization-id] [flags] --right-gateway-info --right-gateway-link --right-gateway-location-read + --right-gateway-purge --right-gateway-read-secrets --right-gateway-settings-api-keys --right-gateway-settings-basic @@ -60,6 +63,7 @@ ttn-lw-cli organizations api-keys create [organization-id] [flags] --right-organization-gateways-create --right-organization-gateways-list --right-organization-info + --right-organization-purge --right-organization-settings-api-keys --right-organization-settings-basic --right-organization-settings-members diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_organizations_api-keys_set.md b/doc/content/ttn-lw-cli/ttn-lw-cli_organizations_api-keys_set.md index 56a224fefc..ac66dec86d 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_organizations_api-keys_set.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_organizations_api-keys_set.md @@ -26,6 +26,7 @@ ttn-lw-cli organizations api-keys set [organization-id] [api-key-id] [flags] --right-application-devices-write-keys --right-application-info --right-application-link + --right-application-purge --right-application-settings-api-keys --right-application-settings-basic --right-application-settings-collaborators @@ -36,6 +37,7 @@ ttn-lw-cli organizations api-keys set [organization-id] [api-key-id] [flags] --right-client-all --right-client-delete --right-client-info + --right-client-purge --right-client-settings-basic --right-client-settings-collaborators --right-gateway-all @@ -43,6 +45,7 @@ ttn-lw-cli organizations api-keys set [organization-id] [api-key-id] [flags] --right-gateway-info --right-gateway-link --right-gateway-location-read + --right-gateway-purge --right-gateway-read-secrets --right-gateway-settings-api-keys --right-gateway-settings-basic @@ -61,6 +64,7 @@ ttn-lw-cli organizations api-keys set [organization-id] [api-key-id] [flags] --right-organization-gateways-create --right-organization-gateways-list --right-organization-info + --right-organization-purge --right-organization-settings-api-keys --right-organization-settings-basic --right-organization-settings-members diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_organizations_collaborators_set.md b/doc/content/ttn-lw-cli/ttn-lw-cli_organizations_collaborators_set.md index 0d49f0b2f4..f899ba77e0 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_organizations_collaborators_set.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_organizations_collaborators_set.md @@ -24,6 +24,7 @@ ttn-lw-cli organizations collaborators set [flags] --right-application-devices-write-keys --right-application-info --right-application-link + --right-application-purge --right-application-settings-api-keys --right-application-settings-basic --right-application-settings-collaborators @@ -34,6 +35,7 @@ ttn-lw-cli organizations collaborators set [flags] --right-client-all --right-client-delete --right-client-info + --right-client-purge --right-client-settings-basic --right-client-settings-collaborators --right-gateway-all @@ -41,6 +43,7 @@ ttn-lw-cli organizations collaborators set [flags] --right-gateway-info --right-gateway-link --right-gateway-location-read + --right-gateway-purge --right-gateway-read-secrets --right-gateway-settings-api-keys --right-gateway-settings-basic @@ -59,6 +62,7 @@ ttn-lw-cli organizations collaborators set [flags] --right-organization-gateways-create --right-organization-gateways-list --right-organization-info + --right-organization-purge --right-organization-settings-api-keys --right-organization-settings-basic --right-organization-settings-members diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_tenants.md b/doc/content/ttn-lw-cli/ttn-lw-cli_tenants.md index 6e7d9ec214..7622bf9c85 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_tenants.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_tenants.md @@ -63,5 +63,6 @@ Tenant commands * [ttn-lw-cli tenants get-registry-totals]({{< relref "ttn-lw-cli_tenants_get-registry-totals" >}}) - Get registry totals of a tenant * [ttn-lw-cli tenants list]({{< relref "ttn-lw-cli_tenants_list" >}}) - List tenants * [ttn-lw-cli tenants search]({{< relref "ttn-lw-cli_tenants_search" >}}) - Search for tenants +* [ttn-lw-cli tenants support-login-token]({{< relref "ttn-lw-cli_tenants_support-login-token" >}}) - Generate a login token associated with the unique 'support' user * [ttn-lw-cli tenants update]({{< relref "ttn-lw-cli_tenants_update" >}}) - Update a tenant diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_tenants_create.md b/doc/content/ttn-lw-cli/ttn-lw-cli_tenants_create.md index 6d58f20fae..c957aba77f 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_tenants_create.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_tenants_create.md @@ -77,6 +77,7 @@ ttn-lw-cli tenants create [tenant-id] [flags] --initial-user.state string allowed values: STATE_REQUESTED, STATE_APPROVED, STATE_REJECTED, STATE_FLAGGED, STATE_SUSPENDED --initial-user.state-description string --initial-user.temporary-password string + --initial-user.universal-rights strings allowed values: right_invalid, RIGHT_USER_INFO, RIGHT_USER_SETTINGS_BASIC, RIGHT_USER_SETTINGS_API_KEYS, RIGHT_USER_DELETE, RIGHT_USER_AUTHORIZED_CLIENTS, RIGHT_USER_APPLICATIONS_LIST, RIGHT_USER_APPLICATIONS_CREATE, RIGHT_USER_GATEWAYS_LIST, RIGHT_USER_GATEWAYS_CREATE, RIGHT_USER_CLIENTS_LIST, RIGHT_USER_CLIENTS_CREATE, RIGHT_USER_ORGANIZATIONS_LIST, RIGHT_USER_ORGANIZATIONS_CREATE, RIGHT_USER_ALL, RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_SETTINGS_BASIC, RIGHT_APPLICATION_SETTINGS_API_KEYS, RIGHT_APPLICATION_SETTINGS_COLLABORATORS, RIGHT_APPLICATION_DELETE, RIGHT_APPLICATION_DEVICES_READ, RIGHT_APPLICATION_DEVICES_WRITE, RIGHT_APPLICATION_DEVICES_READ_KEYS, RIGHT_APPLICATION_DEVICES_WRITE_KEYS, RIGHT_APPLICATION_TRAFFIC_READ, RIGHT_APPLICATION_TRAFFIC_UP_WRITE, RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE, RIGHT_APPLICATION_LINK, RIGHT_APPLICATION_ALL, RIGHT_CLIENT_ALL, RIGHT_GATEWAY_INFO, RIGHT_GATEWAY_SETTINGS_BASIC, RIGHT_GATEWAY_SETTINGS_API_KEYS, RIGHT_GATEWAY_SETTINGS_COLLABORATORS, RIGHT_GATEWAY_DELETE, RIGHT_GATEWAY_TRAFFIC_READ, RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE, RIGHT_GATEWAY_LINK, RIGHT_GATEWAY_STATUS_READ, RIGHT_GATEWAY_LOCATION_READ, RIGHT_GATEWAY_ALL, RIGHT_ORGANIZATION_INFO, RIGHT_ORGANIZATION_SETTINGS_BASIC, RIGHT_ORGANIZATION_SETTINGS_API_KEYS, RIGHT_ORGANIZATION_SETTINGS_MEMBERS, RIGHT_ORGANIZATION_DELETE, RIGHT_ORGANIZATION_APPLICATIONS_LIST, RIGHT_ORGANIZATION_APPLICATIONS_CREATE, RIGHT_ORGANIZATION_GATEWAYS_LIST, RIGHT_ORGANIZATION_GATEWAYS_CREATE, RIGHT_ORGANIZATION_CLIENTS_LIST, RIGHT_ORGANIZATION_CLIENTS_CREATE, RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR, RIGHT_ORGANIZATION_ALL, RIGHT_SEND_INVITES, RIGHT_ALL, RIGHT_APPLICATION_SETTINGS_PACKAGES, RIGHT_GATEWAY_WRITE_SECRETS, RIGHT_GATEWAY_READ_SECRETS, RIGHT_USER_NOTIFICATIONS_READ, RIGHT_CLIENT_INFO, RIGHT_CLIENT_SETTINGS_BASIC, RIGHT_CLIENT_SETTINGS_COLLABORATORS, RIGHT_CLIENT_DELETE, RIGHT_APPLICATION_PURGE, RIGHT_ORGANIZATION_PURGE, RIGHT_USER_PURGE, RIGHT_GATEWAY_PURGE, RIGHT_CLIENT_PURGE, RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE, RIGHT_ALERT_NOTIFICATION_PROFILE_INFO, RIGHT_ALERT_NOTIFICATION_PROFILE_LIST, RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE, RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE, RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE, RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO, RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST, RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE, RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE, RIGHT_AUTHENTICATION_PROVIDER_CREATE, RIGHT_AUTHENTICATION_PROVIDER_INFO, RIGHT_AUTHENTICATION_PROVIDER_LIST, RIGHT_AUTHENTICATION_PROVIDER_UPDATE, RIGHT_AUTHENTICATION_PROVIDER_DELETE, RIGHT_EXTERNAL_USER_CREATE, RIGHT_EXTERNAL_USER_INFO, RIGHT_EXTERNAL_USER_DELETE, RIGHT_USER_LIST, RIGHT_USER_CREATE, RIGHT_PACKET_BROKER_AGENT_READ, RIGHT_PACKET_BROKER_AGENT_WRITE, RIGHT_TENANT_CONFIGURATION_UPDATE --max-applications uint --max-clients uint --max-end-devices uint diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_tenants_support-login-token.md b/doc/content/ttn-lw-cli/ttn-lw-cli_tenants_support-login-token.md new file mode 100644 index 0000000000..8bbab13735 --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_tenants_support-login-token.md @@ -0,0 +1,62 @@ +--- +title: "ttn-lw-cli tenants support-login-token" +slug: ttn-lw-cli_tenants_support-login-token +--- + +## ttn-lw-cli tenants support-login-token + +Generate a login token associated with the unique 'support' user + +``` +ttn-lw-cli tenants support-login-token [tenant-id] [flags] +``` + +### Options + +``` + -h, --help help for support-login-token + --tenant-id string +``` + +### Options inherited from parent commands + +``` + --allow-unknown-hosts Allow sending credentials to unknown hosts + --application-server-enabled Application Server enabled (default true) + --application-server-grpc-address string Application Server address (default "localhost:8884") + --ca string CA certificate file + -c, --config strings Location of the config files (default [.ttn-lw-cli.yml,$HOME/.ttn-lw-cli.yml,$HOME/.config/.ttn-lw-cli.yml]) + --credentials-id string Credentials ID (if using multiple configurations) + --device-claiming-server-grpc-address string Device Claiming Server address (default "localhost:8884") + --device-template-converter-grpc-address string Device Template Converter address (default "localhost:8884") + --dump-requests When log level is set to debug, also dump request payload as JSON + --experimental.features strings Experimental features to activate + --gateway-server-enabled Gateway Server enabled (default true) + --gateway-server-grpc-address string Gateway Server address (default "localhost:8884") + --identity-server-grpc-address string Identity Server address (default "localhost:8884") + --input-format string Input format (default "json") + --insecure Connect without TLS + --join-server-enabled Join Server enabled (default true) + --join-server-grpc-address string Join Server address (default "localhost:8884") + --log.format string Log format to write (console, json) (default "console") + --log.level string The minimum level log messages must have to be shown (default "info") + --network-server-enabled Network Server enabled (default true) + --network-server-grpc-address string Network Server address (default "localhost:8884") + --oauth-server-address string OAuth Server address (default "https://localhost/oauth") + --output-format string Output format (default "json") + --packet-broker-agent-grpc-address string Packet Broker Agent address (default "localhost:8884") + --qr-code-generator-grpc-address string QR Code Generator address (default "localhost:8884") + --retry.default-timeout duration Default timeout between retry attempts (default 100ms) + --retry.enable-metadata Use request response metadata to dynamically calculate timeout between retry attempts (default true) + --retry.jitter float Fraction that creates a deviation of the timeout used between retry attempts + --retry.max uint Maximum amount of times that a request can be reattempted + --skip-version-check Do not perform version checks + --telemetry.enable Enables telemetry for CLI (default true) + --telemetry.target string Target to which the information will be sent to (default "https://telemetry.thethingsstack.io/collect") + --tenant-admin-key string Tenant admin key +``` + +### SEE ALSO + +* [ttn-lw-cli tenants]({{< relref "ttn-lw-cli_tenants" >}}) - Tenant commands + diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_users_api-keys_create.md b/doc/content/ttn-lw-cli/ttn-lw-cli_users_api-keys_create.md index e7e3d16c5e..26e57aad8c 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_users_api-keys_create.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_users_api-keys_create.md @@ -25,6 +25,7 @@ ttn-lw-cli users api-keys create [user-id] [flags] --right-application-devices-write-keys --right-application-info --right-application-link + --right-application-purge --right-application-settings-api-keys --right-application-settings-basic --right-application-settings-collaborators @@ -35,6 +36,7 @@ ttn-lw-cli users api-keys create [user-id] [flags] --right-client-all --right-client-delete --right-client-info + --right-client-purge --right-client-settings-basic --right-client-settings-collaborators --right-gateway-all @@ -42,6 +44,7 @@ ttn-lw-cli users api-keys create [user-id] [flags] --right-gateway-info --right-gateway-link --right-gateway-location-read + --right-gateway-purge --right-gateway-read-secrets --right-gateway-settings-api-keys --right-gateway-settings-basic @@ -60,6 +63,7 @@ ttn-lw-cli users api-keys create [user-id] [flags] --right-organization-gateways-create --right-organization-gateways-list --right-organization-info + --right-organization-purge --right-organization-settings-api-keys --right-organization-settings-basic --right-organization-settings-members @@ -69,13 +73,16 @@ ttn-lw-cli users api-keys create [user-id] [flags] --right-user-authorized-clients --right-user-clients-create --right-user-clients-list + --right-user-create --right-user-delete --right-user-gateways-create --right-user-gateways-list --right-user-info + --right-user-list --right-user-notifications-read --right-user-organizations-create --right-user-organizations-list + --right-user-purge --right-user-settings-api-keys --right-user-settings-basic ``` diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_users_api-keys_set.md b/doc/content/ttn-lw-cli/ttn-lw-cli_users_api-keys_set.md index e8c8b9adb7..980c92a0a8 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_users_api-keys_set.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_users_api-keys_set.md @@ -26,6 +26,7 @@ ttn-lw-cli users api-keys set [user-id] [api-key-id] [flags] --right-application-devices-write-keys --right-application-info --right-application-link + --right-application-purge --right-application-settings-api-keys --right-application-settings-basic --right-application-settings-collaborators @@ -36,6 +37,7 @@ ttn-lw-cli users api-keys set [user-id] [api-key-id] [flags] --right-client-all --right-client-delete --right-client-info + --right-client-purge --right-client-settings-basic --right-client-settings-collaborators --right-gateway-all @@ -43,6 +45,7 @@ ttn-lw-cli users api-keys set [user-id] [api-key-id] [flags] --right-gateway-info --right-gateway-link --right-gateway-location-read + --right-gateway-purge --right-gateway-read-secrets --right-gateway-settings-api-keys --right-gateway-settings-basic @@ -61,6 +64,7 @@ ttn-lw-cli users api-keys set [user-id] [api-key-id] [flags] --right-organization-gateways-create --right-organization-gateways-list --right-organization-info + --right-organization-purge --right-organization-settings-api-keys --right-organization-settings-basic --right-organization-settings-members @@ -70,13 +74,16 @@ ttn-lw-cli users api-keys set [user-id] [api-key-id] [flags] --right-user-authorized-clients --right-user-clients-create --right-user-clients-list + --right-user-create --right-user-delete --right-user-gateways-create --right-user-gateways-list --right-user-info + --right-user-list --right-user-notifications-read --right-user-organizations-create --right-user-organizations-list + --right-user-purge --right-user-settings-api-keys --right-user-settings-basic ``` diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_users_create.md b/doc/content/ttn-lw-cli/ttn-lw-cli_users_create.md index dfe67e3a59..7ed691d4f9 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_users_create.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_users_create.md @@ -33,6 +33,7 @@ ttn-lw-cli users create [user-id] [flags] --state string allowed values: STATE_REQUESTED, STATE_APPROVED, STATE_REJECTED, STATE_FLAGGED, STATE_SUSPENDED --state-description string --temporary-password string + --universal-rights strings allowed values: right_invalid, RIGHT_USER_INFO, RIGHT_USER_SETTINGS_BASIC, RIGHT_USER_SETTINGS_API_KEYS, RIGHT_USER_DELETE, RIGHT_USER_AUTHORIZED_CLIENTS, RIGHT_USER_APPLICATIONS_LIST, RIGHT_USER_APPLICATIONS_CREATE, RIGHT_USER_GATEWAYS_LIST, RIGHT_USER_GATEWAYS_CREATE, RIGHT_USER_CLIENTS_LIST, RIGHT_USER_CLIENTS_CREATE, RIGHT_USER_ORGANIZATIONS_LIST, RIGHT_USER_ORGANIZATIONS_CREATE, RIGHT_USER_ALL, RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_SETTINGS_BASIC, RIGHT_APPLICATION_SETTINGS_API_KEYS, RIGHT_APPLICATION_SETTINGS_COLLABORATORS, RIGHT_APPLICATION_DELETE, RIGHT_APPLICATION_DEVICES_READ, RIGHT_APPLICATION_DEVICES_WRITE, RIGHT_APPLICATION_DEVICES_READ_KEYS, RIGHT_APPLICATION_DEVICES_WRITE_KEYS, RIGHT_APPLICATION_TRAFFIC_READ, RIGHT_APPLICATION_TRAFFIC_UP_WRITE, RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE, RIGHT_APPLICATION_LINK, RIGHT_APPLICATION_ALL, RIGHT_CLIENT_ALL, RIGHT_GATEWAY_INFO, RIGHT_GATEWAY_SETTINGS_BASIC, RIGHT_GATEWAY_SETTINGS_API_KEYS, RIGHT_GATEWAY_SETTINGS_COLLABORATORS, RIGHT_GATEWAY_DELETE, RIGHT_GATEWAY_TRAFFIC_READ, RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE, RIGHT_GATEWAY_LINK, RIGHT_GATEWAY_STATUS_READ, RIGHT_GATEWAY_LOCATION_READ, RIGHT_GATEWAY_ALL, RIGHT_ORGANIZATION_INFO, RIGHT_ORGANIZATION_SETTINGS_BASIC, RIGHT_ORGANIZATION_SETTINGS_API_KEYS, RIGHT_ORGANIZATION_SETTINGS_MEMBERS, RIGHT_ORGANIZATION_DELETE, RIGHT_ORGANIZATION_APPLICATIONS_LIST, RIGHT_ORGANIZATION_APPLICATIONS_CREATE, RIGHT_ORGANIZATION_GATEWAYS_LIST, RIGHT_ORGANIZATION_GATEWAYS_CREATE, RIGHT_ORGANIZATION_CLIENTS_LIST, RIGHT_ORGANIZATION_CLIENTS_CREATE, RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR, RIGHT_ORGANIZATION_ALL, RIGHT_SEND_INVITES, RIGHT_ALL, RIGHT_APPLICATION_SETTINGS_PACKAGES, RIGHT_GATEWAY_WRITE_SECRETS, RIGHT_GATEWAY_READ_SECRETS, RIGHT_USER_NOTIFICATIONS_READ, RIGHT_CLIENT_INFO, RIGHT_CLIENT_SETTINGS_BASIC, RIGHT_CLIENT_SETTINGS_COLLABORATORS, RIGHT_CLIENT_DELETE, RIGHT_APPLICATION_PURGE, RIGHT_ORGANIZATION_PURGE, RIGHT_USER_PURGE, RIGHT_GATEWAY_PURGE, RIGHT_CLIENT_PURGE, RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE, RIGHT_ALERT_NOTIFICATION_PROFILE_INFO, RIGHT_ALERT_NOTIFICATION_PROFILE_LIST, RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE, RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE, RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE, RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO, RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST, RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE, RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE, RIGHT_AUTHENTICATION_PROVIDER_CREATE, RIGHT_AUTHENTICATION_PROVIDER_INFO, RIGHT_AUTHENTICATION_PROVIDER_LIST, RIGHT_AUTHENTICATION_PROVIDER_UPDATE, RIGHT_AUTHENTICATION_PROVIDER_DELETE, RIGHT_EXTERNAL_USER_CREATE, RIGHT_EXTERNAL_USER_INFO, RIGHT_EXTERNAL_USER_DELETE, RIGHT_USER_LIST, RIGHT_USER_CREATE, RIGHT_PACKET_BROKER_AGENT_READ, RIGHT_PACKET_BROKER_AGENT_WRITE, RIGHT_TENANT_CONFIGURATION_UPDATE --user-id string ``` diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_users_get.md b/doc/content/ttn-lw-cli/ttn-lw-cli_users_get.md index 591e336623..3a415d1db3 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_users_get.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_users_get.md @@ -23,9 +23,11 @@ ttn-lw-cli users get [user-id] [flags] --console-preferences.console-theme select the console_preferences.console_theme field --console-preferences.dashboard-layouts select the console_preferences.dashboard_layouts field and all allowed sub-fields --console-preferences.sort-by select the console_preferences.sort_by field and all allowed sub-fields + --console-preferences.tutorials select the console_preferences.tutorials field and all allowed sub-fields --contact-info select the contact_info field --deleted-at select the deleted_at field --description select the description field + --email-notification-preferences select the email_notification_preferences field and all allowed sub-fields --gateway-limit select the gateway_limit field -h, --help help for get --name select the name field @@ -41,6 +43,7 @@ ttn-lw-cli users get [user-id] [flags] --temporary-password select the temporary_password field --temporary-password-created-at select the temporary_password_created_at field --temporary-password-expires-at select the temporary_password_expires_at field + --universal-rights select the universal_rights field --user-id string ``` diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_users_list.md b/doc/content/ttn-lw-cli/ttn-lw-cli_users_list.md index 11ffa536c9..a232ad89fb 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_users_list.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_users_list.md @@ -23,10 +23,12 @@ ttn-lw-cli users list [flags] --console-preferences.console-theme select the console_preferences.console_theme field --console-preferences.dashboard-layouts select the console_preferences.dashboard_layouts field and all allowed sub-fields --console-preferences.sort-by select the console_preferences.sort_by field and all allowed sub-fields + --console-preferences.tutorials select the console_preferences.tutorials field and all allowed sub-fields --contact-info select the contact_info field --deleted --deleted-at select the deleted_at field --description select the description field + --email-notification-preferences select the email_notification_preferences field and all allowed sub-fields --field-mask strings --gateway-limit select the gateway_limit field -h, --help help for list @@ -46,6 +48,7 @@ ttn-lw-cli users list [flags] --temporary-password select the temporary_password field --temporary-password-created-at select the temporary_password_created_at field --temporary-password-expires-at select the temporary_password_expires_at field + --universal-rights select the universal_rights field ``` ### Options inherited from parent commands diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_users_search.md b/doc/content/ttn-lw-cli/ttn-lw-cli_users_search.md index 149f96f404..b5ec8ef9f0 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_users_search.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_users_search.md @@ -24,11 +24,13 @@ ttn-lw-cli users search [flags] --console-preferences.console-theme select the console_preferences.console_theme field --console-preferences.dashboard-layouts select the console_preferences.dashboard_layouts field and all allowed sub-fields --console-preferences.sort-by select the console_preferences.sort_by field and all allowed sub-fields + --console-preferences.tutorials select the console_preferences.tutorials field and all allowed sub-fields --contact-info select the contact_info field --deleted --deleted-at select the deleted_at field --description select the description field --description-contains string + --email-notification-preferences select the email_notification_preferences field and all allowed sub-fields --field-mask strings --gateway-limit select the gateway_limit field -h, --help help for search @@ -51,6 +53,7 @@ ttn-lw-cli users search [flags] --temporary-password select the temporary_password field --temporary-password-created-at select the temporary_password_created_at field --temporary-password-expires-at select the temporary_password_expires_at field + --universal-rights select the universal_rights field ``` ### Options inherited from parent commands diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_users_set.md b/doc/content/ttn-lw-cli/ttn-lw-cli_users_set.md index 9f40f9e0f1..e21db69f24 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_users_set.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_users_set.md @@ -32,6 +32,7 @@ ttn-lw-cli users set [user-id] [flags] --state string allowed values: STATE_REQUESTED, STATE_APPROVED, STATE_REJECTED, STATE_FLAGGED, STATE_SUSPENDED --state-description string --temporary-password string + --universal-rights strings allowed values: right_invalid, RIGHT_USER_INFO, RIGHT_USER_SETTINGS_BASIC, RIGHT_USER_SETTINGS_API_KEYS, RIGHT_USER_DELETE, RIGHT_USER_AUTHORIZED_CLIENTS, RIGHT_USER_APPLICATIONS_LIST, RIGHT_USER_APPLICATIONS_CREATE, RIGHT_USER_GATEWAYS_LIST, RIGHT_USER_GATEWAYS_CREATE, RIGHT_USER_CLIENTS_LIST, RIGHT_USER_CLIENTS_CREATE, RIGHT_USER_ORGANIZATIONS_LIST, RIGHT_USER_ORGANIZATIONS_CREATE, RIGHT_USER_ALL, RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_SETTINGS_BASIC, RIGHT_APPLICATION_SETTINGS_API_KEYS, RIGHT_APPLICATION_SETTINGS_COLLABORATORS, RIGHT_APPLICATION_DELETE, RIGHT_APPLICATION_DEVICES_READ, RIGHT_APPLICATION_DEVICES_WRITE, RIGHT_APPLICATION_DEVICES_READ_KEYS, RIGHT_APPLICATION_DEVICES_WRITE_KEYS, RIGHT_APPLICATION_TRAFFIC_READ, RIGHT_APPLICATION_TRAFFIC_UP_WRITE, RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE, RIGHT_APPLICATION_LINK, RIGHT_APPLICATION_ALL, RIGHT_CLIENT_ALL, RIGHT_GATEWAY_INFO, RIGHT_GATEWAY_SETTINGS_BASIC, RIGHT_GATEWAY_SETTINGS_API_KEYS, RIGHT_GATEWAY_SETTINGS_COLLABORATORS, RIGHT_GATEWAY_DELETE, RIGHT_GATEWAY_TRAFFIC_READ, RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE, RIGHT_GATEWAY_LINK, RIGHT_GATEWAY_STATUS_READ, RIGHT_GATEWAY_LOCATION_READ, RIGHT_GATEWAY_ALL, RIGHT_ORGANIZATION_INFO, RIGHT_ORGANIZATION_SETTINGS_BASIC, RIGHT_ORGANIZATION_SETTINGS_API_KEYS, RIGHT_ORGANIZATION_SETTINGS_MEMBERS, RIGHT_ORGANIZATION_DELETE, RIGHT_ORGANIZATION_APPLICATIONS_LIST, RIGHT_ORGANIZATION_APPLICATIONS_CREATE, RIGHT_ORGANIZATION_GATEWAYS_LIST, RIGHT_ORGANIZATION_GATEWAYS_CREATE, RIGHT_ORGANIZATION_CLIENTS_LIST, RIGHT_ORGANIZATION_CLIENTS_CREATE, RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR, RIGHT_ORGANIZATION_ALL, RIGHT_SEND_INVITES, RIGHT_ALL, RIGHT_APPLICATION_SETTINGS_PACKAGES, RIGHT_GATEWAY_WRITE_SECRETS, RIGHT_GATEWAY_READ_SECRETS, RIGHT_USER_NOTIFICATIONS_READ, RIGHT_CLIENT_INFO, RIGHT_CLIENT_SETTINGS_BASIC, RIGHT_CLIENT_SETTINGS_COLLABORATORS, RIGHT_CLIENT_DELETE, RIGHT_APPLICATION_PURGE, RIGHT_ORGANIZATION_PURGE, RIGHT_USER_PURGE, RIGHT_GATEWAY_PURGE, RIGHT_CLIENT_PURGE, RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE, RIGHT_ALERT_NOTIFICATION_PROFILE_INFO, RIGHT_ALERT_NOTIFICATION_PROFILE_LIST, RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE, RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE, RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE, RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO, RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST, RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE, RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE, RIGHT_AUTHENTICATION_PROVIDER_CREATE, RIGHT_AUTHENTICATION_PROVIDER_INFO, RIGHT_AUTHENTICATION_PROVIDER_LIST, RIGHT_AUTHENTICATION_PROVIDER_UPDATE, RIGHT_AUTHENTICATION_PROVIDER_DELETE, RIGHT_EXTERNAL_USER_CREATE, RIGHT_EXTERNAL_USER_INFO, RIGHT_EXTERNAL_USER_DELETE, RIGHT_USER_LIST, RIGHT_USER_CREATE, RIGHT_PACKET_BROKER_AGENT_READ, RIGHT_PACKET_BROKER_AGENT_WRITE, RIGHT_TENANT_CONFIGURATION_UPDATE --user-id string ``` diff --git a/doc/content/whats-new/3.33.0.md b/doc/content/whats-new/3.33.0.md new file mode 100644 index 0000000000..16d4226ab9 --- /dev/null +++ b/doc/content/whats-new/3.33.0.md @@ -0,0 +1,49 @@ +--- +date: 2025-01-13T15:45:31Z +title: "3.33.0" +featured: + { + added: + [ + "Support user email notification preferences.", + "Support for managing MAC settings profiles.", + "Support pausing webhook in the edit webhook view in console.", + ], + fixed: + [ + "Enforce default page limit on AS and NS List RPCs if a value is not provided in the request.", + ], + } +--- + +### Added + +- Support user email notification preferences. + - This requires an Identity Server database migration (`ttn-lw-stack is-db migrate`). +- Support for managing MAC settings profiles. + - This feature is experimental and subject to change. +- Endpoint for generating support user. + - Only available to tenant administrators, allows the creation of a read-only admin user. +- Add more specific rights for user operations. + - The rights added were for listing and creating rights. + - Admin validation associated with these operations remains. +- Add purge rights for application, organizations, Oauth clients, gateways and user operations. +- Add more specific rights for alert notification profile operations. +- Add more specific rights for alert notification receiver operations. +- Add more specific rights for authentication provider operations. +- Add more specific rights for external user operations. +- Support pausing webhook in the edit webhook view in console +- Add more specific rights for user operations. + - The rights added were for listing and creating rights. + - Admin validation associated with these operations remains. +- Add specific rights for interacting with the Packet Broker Agent. +- Add specific rights for updating a tenant's configuration. + +### Fixed + +- Subscription nudge not showing correct device count in the Console. +- Enforce default page limit on AS and NS List RPCs if a value is not provided in the request. +- Fix OAuth client authorizations delete request in the Console. +- Consecutive disconnect/reconnect messages in the Live Data view in the Console. +- Set retention policy for `application_webhook_failure` table in the Network Operation Center's store. + - This requires a database schema migration (`ttn-lw-stack noc-db migrate`). diff --git a/doc/data/api/tti.lorawan.v3/messages/CreateSupportTokenRequest.yml b/doc/data/api/tti.lorawan.v3/messages/CreateSupportTokenRequest.yml new file mode 100644 index 0000000000..d04fbbe07b --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/CreateSupportTokenRequest.yml @@ -0,0 +1,8 @@ +name: CreateSupportTokenRequest +fields: +- name: tenant_ids + message: + name: TenantIdentifiers + rules: + required: true + default: {} diff --git a/doc/data/api/tti.lorawan.v3/messages/CreateSupportTokenResponse.yml b/doc/data/api/tti.lorawan.v3/messages/CreateSupportTokenResponse.yml new file mode 100644 index 0000000000..5b6a62c0b2 --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/CreateSupportTokenResponse.yml @@ -0,0 +1,8 @@ +name: CreateSupportTokenResponse +fields: +- name: login_token + type: string + default: "" +- name: login_url + type: string + default: "" diff --git a/doc/data/api/tti.lorawan.v3/services/TenantAccess.yml b/doc/data/api/tti.lorawan.v3/services/TenantAccess.yml index bf630b06dd..fbcbebe86e 100644 --- a/doc/data/api/tti.lorawan.v3/services/TenantAccess.yml +++ b/doc/data/api/tti.lorawan.v3/services/TenantAccess.yml @@ -10,3 +10,13 @@ methods: http: - method: POST path: /tenants/{tenant_ids.tenant_id}/resend-admin-validation + CreateSupportToken: + name: CreateSupportToken + comment: 'EXPERIMENTAL: This service is subject to change.' + input: + name: CreateSupportTokenRequest + output: + name: CreateSupportTokenResponse + http: + - method: POST + path: /tenants/{tenant_ids.tenant_id}/support-token diff --git a/doc/data/api/ttn.lorawan.v3/enums/NotificationType.yml b/doc/data/api/ttn.lorawan.v3/enums/NotificationType.yml new file mode 100644 index 0000000000..f50328395b --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/enums/NotificationType.yml @@ -0,0 +1,28 @@ +name: NotificationType +values: +- name: UNKNOWN + value: 0 +- name: API_KEY_CREATED + value: 1 +- name: API_KEY_CHANGED + value: 2 +- name: CLIENT_REQUESTED + value: 3 +- name: COLLABORATOR_CHANGED + value: 4 +- name: ENTITY_STATE_CHANGED + value: 5 +- name: INVITATION + value: 6 +- name: LOGIN_TOKEN + value: 7 +- name: PASSWORD_CHANGED + value: 8 +- name: TEMPORARY_PASSWORD + value: 9 +- name: USER_REQUESTED + value: 10 +- name: VALIDATE + value: 11 +- name: SUPPORT_ACCESS_REQUESTED + value: 12 diff --git a/doc/data/api/ttn.lorawan.v3/enums/Right.yml b/doc/data/api/ttn.lorawan.v3/enums/Right.yml index 540148e9aa..055bf665e3 100644 --- a/doc/data/api/ttn.lorawan.v3/enums/Right.yml +++ b/doc/data/api/ttn.lorawan.v3/enums/Right.yml @@ -10,12 +10,21 @@ values: - name: RIGHT_USER_SETTINGS_BASIC comment: The right to edit basic user settings. value: 2 +- name: RIGHT_USER_LIST + comment: The right to list users accounts. + value: 87 +- name: RIGHT_USER_CREATE + comment: The right to create an user account. + value: 88 - name: RIGHT_USER_SETTINGS_API_KEYS comment: The right to view and edit user API keys. value: 3 - name: RIGHT_USER_DELETE comment: The right to delete user account. value: 4 +- name: RIGHT_USER_PURGE + comment: The right to purge user account. + value: 66 - name: RIGHT_USER_AUTHORIZED_CLIENTS comment: The right to view and edit authorized OAuth clients of the user. value: 5 @@ -67,6 +76,9 @@ values: - name: RIGHT_APPLICATION_DELETE comment: The right to delete application. value: 19 +- name: RIGHT_APPLICATION_PURGE + comment: The right to purge application. + value: 64 - name: RIGHT_APPLICATION_DEVICES_READ comment: The right to view devices in application. value: 20 @@ -116,6 +128,9 @@ values: - name: RIGHT_CLIENT_DELETE comment: The right to delete a client. value: 63 +- name: RIGHT_CLIENT_PURGE + comment: The right to purge a client. + value: 68 - name: RIGHT_GATEWAY_INFO comment: The right to view gateway information. value: 30 @@ -131,6 +146,9 @@ values: - name: RIGHT_GATEWAY_DELETE comment: The right to delete gateway. value: 34 +- name: RIGHT_GATEWAY_PURGE + comment: The right to purge gateway. + value: 67 - name: RIGHT_GATEWAY_TRAFFIC_READ comment: The right to read gateway traffic. value: 35 @@ -174,6 +192,9 @@ values: - name: RIGHT_ORGANIZATION_DELETE comment: The right to delete organization. value: 45 +- name: RIGHT_ORGANIZATION_PURGE + comment: The right to purge organization. + value: 65 - name: RIGHT_ORGANIZATION_APPLICATIONS_LIST comment: The right to list the applications the organization is a collaborator of. value: 46 @@ -204,6 +225,69 @@ values: The right to send invites to new users. Note that this is not prefixed with "USER_"; it is not a right on the user entity. value: 54 +- name: RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE + comment: The right to create an alert notification profile. + value: 69 +- name: RIGHT_ALERT_NOTIFICATION_PROFILE_INFO + comment: The right to view an alert notification profile information. + value: 70 +- name: RIGHT_ALERT_NOTIFICATION_PROFILE_LIST + comment: The right to list the alert notification profiles. + value: 71 +- name: RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE + comment: The right to update an alert notification profiles. + value: 72 +- name: RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE + comment: The right to delete an alert notification profiles. + value: 73 +- name: RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE + comment: The right to create an alert notification receiver. + value: 74 +- name: RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO + comment: The right to view an alert notification receiver information. + value: 75 +- name: RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST + comment: The right to list the alert notification receivers. + value: 76 +- name: RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE + comment: The right to update an alert notification receivers. + value: 77 +- name: RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE + comment: The right to delete an alert notification receivers. + value: 78 +- name: RIGHT_AUTHENTICATION_PROVIDER_CREATE + comment: The right to create an authentication provider. + value: 79 +- name: RIGHT_AUTHENTICATION_PROVIDER_INFO + comment: The right to view an authentication provider information. + value: 80 +- name: RIGHT_AUTHENTICATION_PROVIDER_LIST + comment: The right to list the authentication providers + value: 81 +- name: RIGHT_AUTHENTICATION_PROVIDER_UPDATE + comment: The right to update an authentication providers. + value: 82 +- name: RIGHT_AUTHENTICATION_PROVIDER_DELETE + comment: The right to delete an authentication providers. + value: 83 +- name: RIGHT_EXTERNAL_USER_CREATE + comment: The right to create an external user. + value: 84 +- name: RIGHT_EXTERNAL_USER_INFO + comment: The right to view an external user's information. + value: 85 +- name: RIGHT_EXTERNAL_USER_DELETE + comment: The right to delete an external user. + value: 86 +- name: RIGHT_PACKET_BROKER_AGENT_READ + comment: The right to read any information related to the PBA. + value: 89 +- name: RIGHT_PACKET_BROKER_AGENT_WRITE + comment: The right to perform operations in the PBA. + value: 90 +- name: RIGHT_TENANT_CONFIGURATION_UPDATE + comment: The right to update a tenant's configuration. + value: 91 - name: RIGHT_ALL comment: The pseudo-right for all (current and future) possible rights. value: 55 diff --git a/doc/data/api/ttn.lorawan.v3/enums/Tutorial.yml b/doc/data/api/ttn.lorawan.v3/enums/Tutorial.yml new file mode 100644 index 0000000000..b4817b6102 --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/enums/Tutorial.yml @@ -0,0 +1,7 @@ +name: Tutorial +comment: Tutorial is a set of possible tutorials in the Console. +values: +- name: TUTORIAL_UNKNOWN + value: 0 +- name: TUTORIAL_LIVE_DATA_SPLIT_VIEW + value: 1 diff --git a/doc/data/api/ttn.lorawan.v3/messages/CreateMACSettingsProfileRequest.yml b/doc/data/api/ttn.lorawan.v3/messages/CreateMACSettingsProfileRequest.yml new file mode 100644 index 0000000000..48962688f8 --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/CreateMACSettingsProfileRequest.yml @@ -0,0 +1,9 @@ +name: CreateMACSettingsProfileRequest +fields: +- name: mac_settings_profile + comment: The MAC settings profile to create. + message: + name: MACSettingsProfile + rules: + required: true + default: {} diff --git a/doc/data/api/ttn.lorawan.v3/messages/CreateMACSettingsProfileResponse.yml b/doc/data/api/ttn.lorawan.v3/messages/CreateMACSettingsProfileResponse.yml new file mode 100644 index 0000000000..52953ca4d0 --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/CreateMACSettingsProfileResponse.yml @@ -0,0 +1,9 @@ +name: CreateMACSettingsProfileResponse +fields: +- name: mac_settings_profile + comment: The MAC settings profile. + message: + name: MACSettingsProfile + rules: + required: true + default: {} diff --git a/doc/data/api/ttn.lorawan.v3/messages/CreateNotificationRequest.yml b/doc/data/api/ttn.lorawan.v3/messages/CreateNotificationRequest.yml index 90a9bebc6e..19a41d0393 100644 --- a/doc/data/api/ttn.lorawan.v3/messages/CreateNotificationRequest.yml +++ b/doc/data/api/ttn.lorawan.v3/messages/CreateNotificationRequest.yml @@ -11,8 +11,20 @@ fields: comment: The type of this notification. type: string rules: - min_len: 1 - max_len: 100 + in: + - unknown + - api_key_created + - api_key_changed + - client_requested + - collaborator_changed + - entity_state_changed + - invitation + - login_token + - password_changed + - temporary_password + - user_requested + - validate + - support_access_requested default: "" - name: data comment: The data related to the notification. diff --git a/doc/data/api/ttn.lorawan.v3/messages/DeleteMACSettingsProfileRequest.yml b/doc/data/api/ttn.lorawan.v3/messages/DeleteMACSettingsProfileRequest.yml new file mode 100644 index 0000000000..3499bd6e23 --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/DeleteMACSettingsProfileRequest.yml @@ -0,0 +1,9 @@ +name: DeleteMACSettingsProfileRequest +fields: +- name: mac_settings_profile_ids + comment: The identifiers of the MAC settings profile. + message: + name: MACSettingsProfileIdentifiers + rules: + required: true + default: {} diff --git a/doc/data/api/ttn.lorawan.v3/messages/DeleteMACSettingsProfileResponse.yml b/doc/data/api/ttn.lorawan.v3/messages/DeleteMACSettingsProfileResponse.yml new file mode 100644 index 0000000000..43f8bf226a --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/DeleteMACSettingsProfileResponse.yml @@ -0,0 +1 @@ +name: DeleteMACSettingsProfileResponse diff --git a/doc/data/api/ttn.lorawan.v3/messages/EmailNotificationPreferences.yml b/doc/data/api/ttn.lorawan.v3/messages/EmailNotificationPreferences.yml new file mode 100644 index 0000000000..0bad44b434 --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/EmailNotificationPreferences.yml @@ -0,0 +1,13 @@ +name: EmailNotificationPreferences +comment: EmailNotificationPreferences is the message that defines the types of notifications + for which the user wants to receive an email. +fields: +- name: types + rules: + unique: true + repeated: + enum: + name: NotificationType + rules: + defined_only: true + default: [] diff --git a/doc/data/api/ttn.lorawan.v3/messages/GetMACSettingsProfileRequest.yml b/doc/data/api/ttn.lorawan.v3/messages/GetMACSettingsProfileRequest.yml new file mode 100644 index 0000000000..493d2d004d --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/GetMACSettingsProfileRequest.yml @@ -0,0 +1,15 @@ +name: GetMACSettingsProfileRequest +fields: +- name: mac_settings_profile_ids + comment: The identifiers of the MAC settings profile. + message: + name: MACSettingsProfileIdentifiers + rules: + required: true + default: {} +- name: field_mask + comment: The names of the fields that should be returned. + message: + package: google.protobuf + name: FieldMask + default: {} diff --git a/doc/data/api/ttn.lorawan.v3/messages/GetMACSettingsProfileResponse.yml b/doc/data/api/ttn.lorawan.v3/messages/GetMACSettingsProfileResponse.yml new file mode 100644 index 0000000000..8bf7759b3d --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/GetMACSettingsProfileResponse.yml @@ -0,0 +1,9 @@ +name: GetMACSettingsProfileResponse +fields: +- name: mac_settings_profile + comment: The MAC settings profile. + message: + name: MACSettingsProfile + rules: + required: true + default: {} diff --git a/doc/data/api/ttn.lorawan.v3/messages/ListMACSettingsProfilesRequest.yml b/doc/data/api/ttn.lorawan.v3/messages/ListMACSettingsProfilesRequest.yml new file mode 100644 index 0000000000..5ba1402171 --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/ListMACSettingsProfilesRequest.yml @@ -0,0 +1,36 @@ +name: ListMACSettingsProfilesRequest +fields: +- name: application_ids + comment: The identifiers of the application. + message: + name: ApplicationIdentifiers + rules: + required: true + default: {} +- name: field_mask + comment: The names of the fields that should be returned. + message: + package: google.protobuf + name: FieldMask + default: {} +- name: order + comment: |- + 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. + type: string + rules: + in: + - "" + - ids.profile_id + - -ids.profile_id + default: "" +- name: limit + comment: Limit the number of results per page. + type: uint32 + rules: + lte: 1000 + default: 0 +- name: page + comment: Page number for pagination. 0 is interpreted as 1. + type: uint32 + default: 0 diff --git a/doc/data/api/ttn.lorawan.v3/messages/ListMACSettingsProfilesResponse.yml b/doc/data/api/ttn.lorawan.v3/messages/ListMACSettingsProfilesResponse.yml new file mode 100644 index 0000000000..6f5d855e02 --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/ListMACSettingsProfilesResponse.yml @@ -0,0 +1,8 @@ +name: ListMACSettingsProfilesResponse +fields: +- name: mac_settings_profiles + comment: The MAC settings profiles. + repeated: + message: + name: MACSettingsProfile + default: [] diff --git a/doc/data/api/ttn.lorawan.v3/messages/MACSettingsProfile.yml b/doc/data/api/ttn.lorawan.v3/messages/MACSettingsProfile.yml new file mode 100644 index 0000000000..06ee5cbf79 --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/MACSettingsProfile.yml @@ -0,0 +1,16 @@ +name: MACSettingsProfile +fields: +- name: ids + comment: Profile identifiers. + message: + name: MACSettingsProfileIdentifiers + rules: + required: true + default: {} +- name: mac_settings + comment: MAC settings. + message: + name: MACSettings + rules: + required: true + default: {} diff --git a/doc/data/api/ttn.lorawan.v3/messages/MACSettingsProfileIdentifiers.yml b/doc/data/api/ttn.lorawan.v3/messages/MACSettingsProfileIdentifiers.yml new file mode 100644 index 0000000000..9dd2ea49a2 --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/MACSettingsProfileIdentifiers.yml @@ -0,0 +1,16 @@ +name: MACSettingsProfileIdentifiers +fields: +- name: application_ids + comment: Application IDs. + message: + name: ApplicationIdentifiers + rules: + required: true + default: {} +- name: profile_id + comment: Profile ID. + type: string + rules: + max_len: 36 + pattern: ^[a-z0-9](?:[-]?[a-z0-9]){2,}$ + default: "" diff --git a/doc/data/api/ttn.lorawan.v3/messages/Notification.yml b/doc/data/api/ttn.lorawan.v3/messages/Notification.yml index 35b4105d7d..d878ec2946 100644 --- a/doc/data/api/ttn.lorawan.v3/messages/Notification.yml +++ b/doc/data/api/ttn.lorawan.v3/messages/Notification.yml @@ -16,8 +16,25 @@ fields: name: EntityIdentifiers default: {} - name: notification_type - comment: The type of this notification. + comment: |- + The type of this notification. + TODO: Replace with type NotificationType in v4 https://github.com/TheThingsNetwork/lorawan-stack/issues/7384. type: string + rules: + in: + - unknown + - api_key_created + - api_key_changed + - client_requested + - collaborator_changed + - entity_state_changed + - invitation + - login_token + - password_changed + - temporary_password + - user_requested + - validate + - support_access_requested default: "" - name: data comment: The data related to the notification. diff --git a/doc/data/api/ttn.lorawan.v3/messages/UpdateMACSettingsProfileRequest.yml b/doc/data/api/ttn.lorawan.v3/messages/UpdateMACSettingsProfileRequest.yml new file mode 100644 index 0000000000..0b7dd6adcc --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/UpdateMACSettingsProfileRequest.yml @@ -0,0 +1,22 @@ +name: UpdateMACSettingsProfileRequest +fields: +- name: mac_settings_profile_ids + comment: The identifiers of the MAC settings profile. + message: + name: MACSettingsProfileIdentifiers + rules: + required: true + default: {} +- name: mac_settings_profile + comment: The MAC settings profile to update. + message: + name: MACSettingsProfile + rules: + required: true + default: {} +- name: field_mask + comment: The names of the fields that should be updated. + message: + package: google.protobuf + name: FieldMask + default: {} diff --git a/doc/data/api/ttn.lorawan.v3/messages/UpdateMACSettingsProfileResponse.yml b/doc/data/api/ttn.lorawan.v3/messages/UpdateMACSettingsProfileResponse.yml new file mode 100644 index 0000000000..a713f07012 --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/UpdateMACSettingsProfileResponse.yml @@ -0,0 +1,9 @@ +name: UpdateMACSettingsProfileResponse +fields: +- name: mac_settings_profile + comment: The MAC settings profile. + message: + name: MACSettingsProfile + rules: + required: true + default: {} diff --git a/doc/data/api/ttn.lorawan.v3/messages/User.yml b/doc/data/api/ttn.lorawan.v3/messages/User.yml index b576a480b7..7fba2a541f 100644 --- a/doc/data/api/ttn.lorawan.v3/messages/User.yml +++ b/doc/data/api/ttn.lorawan.v3/messages/User.yml @@ -191,3 +191,14 @@ fields: message: name: UserConsolePreferences default: {} +- name: email_notification_preferences + message: + name: EmailNotificationPreferences + default: {} +- name: universal_rights + comment: Universal rights are capable of restricting the user's interactions with + the API, be it an admin or not. + repeated: + enum: + name: Right + default: [] diff --git a/doc/data/api/ttn.lorawan.v3/messages/UserConsolePreferences.Tutorials.yml b/doc/data/api/ttn.lorawan.v3/messages/UserConsolePreferences.Tutorials.yml new file mode 100644 index 0000000000..1c66354230 --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/UserConsolePreferences.Tutorials.yml @@ -0,0 +1,11 @@ +name: UserConsolePreferences.Tutorials +fields: +- name: seen + rules: + unique: true + repeated: + enum: + name: Tutorial + rules: + defined_only: true + default: [] diff --git a/doc/data/api/ttn.lorawan.v3/messages/UserConsolePreferences.yml b/doc/data/api/ttn.lorawan.v3/messages/UserConsolePreferences.yml index 520df046c0..c51d6f5adb 100644 --- a/doc/data/api/ttn.lorawan.v3/messages/UserConsolePreferences.yml +++ b/doc/data/api/ttn.lorawan.v3/messages/UserConsolePreferences.yml @@ -14,3 +14,7 @@ fields: message: name: UserConsolePreferences.SortBy default: {} +- name: tutorials + message: + name: UserConsolePreferences.Tutorials + default: {} diff --git a/doc/data/api/ttn.lorawan.v3/services/NsMACSettingsProfileRegistry.yml b/doc/data/api/ttn.lorawan.v3/services/NsMACSettingsProfileRegistry.yml new file mode 100644 index 0000000000..4fb870e197 --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/services/NsMACSettingsProfileRegistry.yml @@ -0,0 +1,55 @@ +name: NsMACSettingsProfileRegistry +comment: |- + The NsMACSettingsProfileRegistry service allows clients to manage MAC settings profiles on the Network Server. + EXPERIMENTAL: This service is subject to change. +methods: + Create: + name: Create + comment: Create creates a new MAC settings profile. + input: + name: CreateMACSettingsProfileRequest + output: + name: CreateMACSettingsProfileResponse + http: + - method: POST + path: /ns/applications/{mac_settings_profile.ids.application_ids.application_id}/mac_settings_profiles + Get: + name: Get + comment: Get returns the MAC settings profile that matches the given identifiers. + input: + name: GetMACSettingsProfileRequest + output: + name: GetMACSettingsProfileResponse + http: + - method: GET + path: /ns/applications/{mac_settings_profile_ids.application_ids.application_id}/mac_settings_profiles/{mac_settings_profile_ids.profile_id} + Update: + name: Update + comment: Update updates the MAC settings profile that matches the given identifiers. + input: + name: UpdateMACSettingsProfileRequest + output: + name: UpdateMACSettingsProfileResponse + http: + - method: PUT + path: /ns/applications/{mac_settings_profile_ids.application_ids.application_id}/mac_settings_profiles/{mac_settings_profile_ids.profile_id} + Delete: + name: Delete + comment: Delete deletes the MAC settings profile that matches the given identifiers. + input: + name: DeleteMACSettingsProfileRequest + output: + name: DeleteMACSettingsProfileResponse + http: + - method: DELETE + path: /ns/applications/{mac_settings_profile_ids.application_ids.application_id}/mac_settings_profiles/{mac_settings_profile_ids.profile_id} + List: + name: List + comment: List lists the MAC settings profiles. + input: + name: ListMACSettingsProfilesRequest + output: + name: ListMACSettingsProfilesResponse + http: + - method: GET + path: /ns/applications/{application_ids.application_id}/mac_settings_profiles diff --git a/doc/data/api/tts.swagger.json b/doc/data/api/tts.swagger.json index 4873f169d4..2e9ae2ee19 100644 --- a/doc/data/api/tts.swagger.json +++ b/doc/data/api/tts.swagger.json @@ -8,7 +8,7 @@ "swagger": "2.0", "info": { "title": "The Things Stack for LoRaWAN® OpenAPI 2.0 Reference", - "version": "3.32.3" + "version": "3.33.0" }, "paths": { "/alerts/notifications/profiles": { @@ -2228,15 +2228,18 @@ "description": "Rights that are granted to this API key.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -2254,6 +2257,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -2268,11 +2272,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -2286,6 +2292,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -2295,6 +2302,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -2373,15 +2401,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -2399,6 +2430,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -2413,11 +2445,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -2431,6 +2465,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -2440,6 +2475,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -2478,15 +2534,18 @@ "description": "Rights that are granted to this API key.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -2504,6 +2563,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -2518,11 +2578,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -2536,6 +2598,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -2545,6 +2608,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -2640,15 +2724,18 @@ "description": "Rights that are granted to this API key.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -2666,6 +2753,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -2680,11 +2768,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -2698,6 +2788,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -2707,6 +2798,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -2758,15 +2870,18 @@ "description": "Rights that are granted to this API key.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -2784,6 +2899,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -2798,11 +2914,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -2816,6 +2934,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -2825,6 +2944,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -2920,15 +3060,18 @@ "description": "Rights that are granted to this API key.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -2946,6 +3089,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -2960,11 +3104,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -2978,6 +3124,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -2987,6 +3134,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -3160,15 +3328,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -3186,6 +3357,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -3200,11 +3372,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -3218,6 +3392,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -3227,6 +3402,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -3411,15 +3607,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -3437,6 +3636,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -3451,11 +3651,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -3469,6 +3671,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -3478,6 +3681,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -3667,15 +3891,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -3693,6 +3920,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -3707,11 +3935,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -3725,6 +3955,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -3734,6 +3965,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -3833,15 +4085,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -3859,6 +4114,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -3873,11 +4129,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -3891,6 +4149,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -3900,6 +4159,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -41373,15 +41653,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -41399,6 +41682,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -41413,11 +41697,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -41431,6 +41717,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -41440,6 +41727,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -178676,7 +178984,54 @@ "format": "date-time" }, "last_failed_attempt_details": { - "$ref": "#/definitions/v3ErrorDetails" + "description": "Error details that are communicated over gRPC (and HTTP) APIs.\nThe messages (for translation) are stored as \"error:\u003cnamespace\u003e:\u003cname\u003e\".", + "type": "object", + "properties": { + "attributes": { + "description": "Attributes that should be filled into the message format. Any extra attributes\ncan be displayed as error details.", + "type": "object" + }, + "cause": { + "description": "The error that caused this error.", + "$ref": "#/definitions/v3ErrorDetails" + }, + "code": { + "description": "The status code of the error.", + "type": "integer", + "format": "int64" + }, + "correlation_id": { + "description": "The correlation ID of the error can be used to correlate the error to stack\ntraces the network may (or may not) store about recent errors.", + "type": "string" + }, + "details": { + "description": "The details of the error.", + "type": "array", + "items": { + "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }", + "type": "object", + "properties": { + "@type": { + "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.", + "type": "string" + } + }, + "additionalProperties": {} + } + }, + "message_format": { + "description": "The default (fallback) message format that should be used for the error.\nThis is also used if the client does not have a translation for the error.", + "type": "string" + }, + "name": { + "description": "Name of the error.", + "type": "string" + }, + "namespace": { + "description": "Namespace of the error (typically the package name in The Things Stack).", + "type": "string" + } + } } } } @@ -179189,7 +179544,54 @@ "format": "date-time" }, "last_failed_attempt_details": { - "$ref": "#/definitions/v3ErrorDetails" + "description": "Error details that are communicated over gRPC (and HTTP) APIs.\nThe messages (for translation) are stored as \"error:\u003cnamespace\u003e:\u003cname\u003e\".", + "type": "object", + "properties": { + "attributes": { + "description": "Attributes that should be filled into the message format. Any extra attributes\ncan be displayed as error details.", + "type": "object" + }, + "cause": { + "description": "The error that caused this error.", + "$ref": "#/definitions/v3ErrorDetails" + }, + "code": { + "description": "The status code of the error.", + "type": "integer", + "format": "int64" + }, + "correlation_id": { + "description": "The correlation ID of the error can be used to correlate the error to stack\ntraces the network may (or may not) store about recent errors.", + "type": "string" + }, + "details": { + "description": "The details of the error.", + "type": "array", + "items": { + "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }", + "type": "object", + "properties": { + "@type": { + "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.", + "type": "string" + } + }, + "additionalProperties": {} + } + }, + "message_format": { + "description": "The default (fallback) message format that should be used for the error.\nThis is also used if the client does not have a translation for the error.", + "type": "string" + }, + "name": { + "description": "Name of the error.", + "type": "string" + }, + "namespace": { + "description": "Namespace of the error (typically the package name in The Things Stack).", + "type": "string" + } + } } } } @@ -179615,15 +180017,18 @@ "description": "Rights that are granted to this API key.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -179641,6 +180046,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -179655,11 +180061,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -179673,6 +180081,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -179682,6 +180091,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -179806,15 +180236,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -179832,6 +180265,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -179846,11 +180280,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -179864,6 +180300,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -179873,6 +180310,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -179913,15 +180371,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -179939,6 +180400,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -179953,11 +180415,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -179971,6 +180435,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -179980,6 +180445,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -180008,15 +180494,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -180034,6 +180523,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -180048,11 +180538,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -180066,6 +180558,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -180075,6 +180568,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -181352,15 +181866,18 @@ "description": "Rights denotes what rights the client will have access to.\nThis information is public and can be seen by any authenticated user in the network.\nUsers that previously authorized this client will have to re-authorize the\nclient after rights are added to this list.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -181378,6 +181895,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -181392,11 +181910,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -181410,6 +181930,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -181419,6 +181940,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -181675,15 +182217,18 @@ "description": "Rights denotes what rights the client will have access to.\nThis information is public and can be seen by any authenticated user in the network.\nUsers that previously authorized this client will have to re-authorize the\nclient after rights are added to this list.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -181701,6 +182246,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -181715,11 +182261,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -181733,6 +182281,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -181742,6 +182291,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -181955,15 +182525,18 @@ "description": "Rights denotes what rights the client will have access to.\nThis information is public and can be seen by any authenticated user in the network.\nUsers that previously authorized this client will have to re-authorize the\nclient after rights are added to this list.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -181981,6 +182554,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -181995,11 +182569,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -182013,6 +182589,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -182022,6 +182599,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -182282,15 +182880,18 @@ "description": "Rights denotes what rights the client will have access to.\nThis information is public and can be seen by any authenticated user in the network.\nUsers that previously authorized this client will have to re-authorize the\nclient after rights are added to this list.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -182308,6 +182909,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -182322,11 +182924,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -182340,6 +182944,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -182349,6 +182954,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -182517,15 +183143,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -182543,6 +183172,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -182557,11 +183187,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -182575,6 +183207,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -182584,6 +183217,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -182695,15 +183349,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -182721,6 +183378,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -182735,11 +183393,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -182753,6 +183413,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -182762,6 +183423,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -182878,15 +183560,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -182904,6 +183589,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -182918,11 +183604,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -182936,6 +183624,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -182945,6 +183634,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -183044,15 +183754,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -183070,6 +183783,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -183084,11 +183798,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -183102,6 +183818,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -183111,6 +183828,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -183620,15 +184358,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -183646,6 +184387,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -183660,11 +184402,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -183678,6 +184422,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -183687,6 +184432,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -252845,15 +253611,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -252871,6 +253640,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -252885,11 +253655,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -252903,6 +253675,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -252912,6 +253685,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -253149,15 +253943,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -253175,6 +253972,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -253189,11 +253987,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -253207,6 +254007,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -253216,6 +254017,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -254306,8 +255128,11 @@ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -254325,6 +255150,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -254339,11 +255165,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -254357,6 +255185,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -254366,12 +255195,33 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ], "type": "string" }, "collectionFormat": "multi", - "description": " - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": " - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "name": "required.rights", "in": "query" } @@ -255749,15 +256599,18 @@ "description": "Rights that are granted to this API key.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -255775,6 +256628,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -255789,11 +256643,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -255807,6 +256663,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -255816,6 +256673,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -255902,15 +256780,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -255928,6 +256809,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -255942,11 +256824,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -255960,6 +256844,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -255969,6 +256854,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -256007,15 +256913,18 @@ "description": "Rights that are granted to this API key.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -256033,6 +256942,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -256047,11 +256957,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -256065,6 +256977,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -256074,6 +256987,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -256169,15 +257103,18 @@ "description": "Rights that are granted to this API key.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -256195,6 +257132,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -256209,11 +257147,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -256227,6 +257167,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -256236,6 +257177,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -256295,15 +257257,18 @@ "description": "Rights that are granted to this API key.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -256321,6 +257286,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -256335,11 +257301,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -256353,6 +257321,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -256362,6 +257331,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -256464,15 +257454,18 @@ "description": "Rights that are granted to this API key.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -256490,6 +257483,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -256504,11 +257498,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -256522,6 +257518,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -256531,6 +257528,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -256718,15 +257736,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -256744,6 +257765,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -256758,11 +257780,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -256776,6 +257800,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -256785,6 +257810,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -256903,15 +257949,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -256929,6 +257978,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -256943,11 +257993,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -256961,6 +258013,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -256970,6 +258023,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -257093,15 +258167,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -257119,6 +258196,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -257133,11 +258211,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -257151,6 +258231,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -257160,6 +258241,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -257256,15 +258358,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -257282,6 +258387,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -257296,11 +258402,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -257314,6 +258422,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -257323,6 +258432,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -257885,15 +259015,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -257911,6 +259044,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -257925,11 +259059,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -257943,6 +259079,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -257952,6 +259089,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -342263,6 +343421,1618 @@ } } }, + "/ns/applications/{application_ids.application_id}/mac_settings_profiles": { + "get": { + "tags": [ + "NsMACSettingsProfileRegistry" + ], + "summary": "List lists the MAC settings profiles.", + "operationId": "NsMACSettingsProfileRegistry_List", + "parameters": [ + { + "type": "string", + "name": "application_ids.application_id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "The names of the fields that should be returned.", + "name": "field_mask", + "in": "query" + }, + { + "type": "string", + "description": "Order the results by this field path (must be present in the field mask).\nDefault ordering is by ID. Prepend with a minus (-) to reverse the order.", + "name": "order", + "in": "query" + }, + { + "type": "integer", + "format": "int64", + "description": "Limit the number of results per page.", + "name": "limit", + "in": "query" + }, + { + "type": "integer", + "format": "int64", + "description": "Page number for pagination. 0 is interpreted as 1.", + "name": "page", + "in": "query" + } + ], + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "type": "object", + "properties": { + "mac_settings_profiles": { + "description": "The MAC settings profiles.", + "type": "array", + "items": { + "type": "object", + "properties": { + "ids": { + "type": "object", + "properties": { + "application_ids": { + "type": "object", + "properties": { + "application_id": { + "type": "string" + } + } + }, + "profile_id": { + "description": "Profile ID.", + "type": "string" + } + } + }, + "mac_settings": { + "type": "object", + "properties": { + "adr": { + "description": "Adaptive Data Rate settings.", + "type": "object", + "properties": { + "disabled": { + "description": "Configuration options for cases in which ADR is to be disabled\ncompletely.", + "type": "object" + }, + "dynamic": { + "description": "Configuration options for dynamic ADR.", + "type": "object", + "properties": { + "channel_steering": { + "description": "EXPERIMENTAL: Channel steering settings.", + "type": "object", + "properties": { + "disabled": { + "description": "Configuration options for cases in which ADR is not supposed to steer the end device\nto another set of channels.", + "type": "object" + }, + "lora_narrow": { + "description": "Configuration options for LoRa narrow channels steering.\nThe narrow mode attempts to steer the end device towards\nusing the LoRa modulated, 125kHz bandwidth channels.", + "type": "object" + } + } + }, + "margin": { + "description": "The ADR margin (dB) tells the network server how much margin it should add in ADR requests.\nA bigger margin is less efficient, but gives a better chance of successful reception.\nIf unset, the default value from Network Server configuration will be used.", + "type": "number", + "format": "float" + }, + "max_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "max_tx_power_index": { + "description": "Maximum transmission power index.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_tx_power_index": { + "description": "Minimum transmission power index.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "overrides": { + "description": "EXPERIMENTAL: Configuration overrides.", + "type": "object", + "properties": { + "data_rate_0": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_1": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_10": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_11": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_12": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_13": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_14": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_15": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_2": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_3": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_4": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_5": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_6": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_7": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_8": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_9": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + } + } + } + } + }, + "static": { + "description": "Configuration options for static ADR.", + "type": "object", + "properties": { + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "nb_trans": { + "description": "Number of retransmissions.", + "type": "integer", + "format": "int64" + }, + "tx_power_index": { + "description": "Transmission power index to use.", + "type": "integer", + "format": "int64" + } + } + } + } + }, + "adr_margin": { + "description": "The ADR margin (dB) tells the network server how much margin it should add in ADR requests.\nA bigger margin is less efficient, but gives a better chance of successful reception.\nThis field is deprecated, use adr_settings.dynamic.margin instead.", + "type": "number", + "format": "float" + }, + "beacon_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "class_b_c_downlink_interval": { + "description": "The minimum duration passed before a network-initiated(e.g. Class B or C) downlink following an arbitrary downlink.", + "type": "string" + }, + "class_b_timeout": { + "description": "Maximum delay for the device to answer a MAC request or a confirmed downlink frame.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "class_c_timeout": { + "description": "Maximum delay for the device to answer a MAC request or a confirmed downlink frame.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "desired_adr_ack_delay_exponent": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "ADR_ACK_DELAY_1", + "enum": [ + "ADR_ACK_DELAY_1", + "ADR_ACK_DELAY_2", + "ADR_ACK_DELAY_4", + "ADR_ACK_DELAY_8", + "ADR_ACK_DELAY_16", + "ADR_ACK_DELAY_32", + "ADR_ACK_DELAY_64", + "ADR_ACK_DELAY_128", + "ADR_ACK_DELAY_256", + "ADR_ACK_DELAY_512", + "ADR_ACK_DELAY_1024", + "ADR_ACK_DELAY_2048", + "ADR_ACK_DELAY_4096", + "ADR_ACK_DELAY_8192", + "ADR_ACK_DELAY_16384", + "ADR_ACK_DELAY_32768" + ] + } + } + }, + "desired_adr_ack_limit_exponent": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "ADR_ACK_LIMIT_1", + "enum": [ + "ADR_ACK_LIMIT_1", + "ADR_ACK_LIMIT_2", + "ADR_ACK_LIMIT_4", + "ADR_ACK_LIMIT_8", + "ADR_ACK_LIMIT_16", + "ADR_ACK_LIMIT_32", + "ADR_ACK_LIMIT_64", + "ADR_ACK_LIMIT_128", + "ADR_ACK_LIMIT_256", + "ADR_ACK_LIMIT_512", + "ADR_ACK_LIMIT_1024", + "ADR_ACK_LIMIT_2048", + "ADR_ACK_LIMIT_4096", + "ADR_ACK_LIMIT_8192", + "ADR_ACK_LIMIT_16384", + "ADR_ACK_LIMIT_32768" + ] + } + } + }, + "desired_beacon_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "desired_max_duty_cycle": { + "type": "object", + "properties": { + "value": { + "description": " - DUTY_CYCLE_1: 100%.\n - DUTY_CYCLE_2: 50%.\n - DUTY_CYCLE_4: 25%.\n - DUTY_CYCLE_8: 12.5%.\n - DUTY_CYCLE_16: 6.25%.\n - DUTY_CYCLE_32: 3.125%.\n - DUTY_CYCLE_64: 1.5625%.\n - DUTY_CYCLE_128: Roughly 0.781%.\n - DUTY_CYCLE_256: Roughly 0.390%.\n - DUTY_CYCLE_512: Roughly 0.195%.\n - DUTY_CYCLE_1024: Roughly 0.098%.\n - DUTY_CYCLE_2048: Roughly 0.049%.\n - DUTY_CYCLE_4096: Roughly 0.024%.\n - DUTY_CYCLE_8192: Roughly 0.012%.\n - DUTY_CYCLE_16384: Roughly 0.006%.\n - DUTY_CYCLE_32768: Roughly 0.003%.", + "type": "string", + "default": "DUTY_CYCLE_1", + "enum": [ + "DUTY_CYCLE_1", + "DUTY_CYCLE_2", + "DUTY_CYCLE_4", + "DUTY_CYCLE_8", + "DUTY_CYCLE_16", + "DUTY_CYCLE_32", + "DUTY_CYCLE_64", + "DUTY_CYCLE_128", + "DUTY_CYCLE_256", + "DUTY_CYCLE_512", + "DUTY_CYCLE_1024", + "DUTY_CYCLE_2048", + "DUTY_CYCLE_4096", + "DUTY_CYCLE_8192", + "DUTY_CYCLE_16384", + "DUTY_CYCLE_32768" + ] + } + } + }, + "desired_max_eirp": { + "type": "object", + "properties": { + "value": { + "description": " - DEVICE_EIRP_8: 8 dBm.\n - DEVICE_EIRP_10: 10 dBm.\n - DEVICE_EIRP_12: 12 dBm.\n - DEVICE_EIRP_13: 13 dBm.\n - DEVICE_EIRP_14: 14 dBm.\n - DEVICE_EIRP_16: 16 dBm.\n - DEVICE_EIRP_18: 18 dBm.\n - DEVICE_EIRP_20: 20 dBm.\n - DEVICE_EIRP_21: 21 dBm.\n - DEVICE_EIRP_24: 24 dBm.\n - DEVICE_EIRP_26: 26 dBm.\n - DEVICE_EIRP_27: 27 dBm.\n - DEVICE_EIRP_29: 29 dBm.\n - DEVICE_EIRP_30: 30 dBm.\n - DEVICE_EIRP_33: 33 dBm.\n - DEVICE_EIRP_36: 36 dBm.", + "type": "string", + "default": "DEVICE_EIRP_8", + "enum": [ + "DEVICE_EIRP_8", + "DEVICE_EIRP_10", + "DEVICE_EIRP_12", + "DEVICE_EIRP_13", + "DEVICE_EIRP_14", + "DEVICE_EIRP_16", + "DEVICE_EIRP_18", + "DEVICE_EIRP_20", + "DEVICE_EIRP_21", + "DEVICE_EIRP_24", + "DEVICE_EIRP_26", + "DEVICE_EIRP_27", + "DEVICE_EIRP_29", + "DEVICE_EIRP_30", + "DEVICE_EIRP_33", + "DEVICE_EIRP_36" + ] + } + } + }, + "desired_ping_slot_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "desired_ping_slot_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "desired_relay": { + "description": "RelaySettings represent the settings of a relay.\nThis is used internally by the Network Server.", + "type": "object", + "properties": { + "served": { + "type": "object", + "properties": { + "always": { + "type": "object" + }, + "backoff": { + "description": "Number of wake on radio frames to be sent without an acknowledgement before sending the uplink message directly.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "dynamic": { + "type": "object", + "properties": { + "smart_enable_level": { + "type": "string", + "default": "RELAY_SMART_ENABLE_LEVEL_8", + "enum": [ + "RELAY_SMART_ENABLE_LEVEL_8", + "RELAY_SMART_ENABLE_LEVEL_16", + "RELAY_SMART_ENABLE_LEVEL_32", + "RELAY_SMART_ENABLE_LEVEL_64" + ] + } + } + }, + "end_device_controlled": { + "type": "object" + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "serving_device_id": { + "description": "End device identifier of the serving end device.", + "type": "string" + } + } + }, + "serving": { + "type": "object", + "properties": { + "cad_periodicity": { + "type": "string", + "title": "- RELAY_CAD_PERIODICITY_20_MILLISECONDS: sic", + "default": "RELAY_CAD_PERIODICITY_1_SECOND", + "enum": [ + "RELAY_CAD_PERIODICITY_1_SECOND", + "RELAY_CAD_PERIODICITY_500_MILLISECONDS", + "RELAY_CAD_PERIODICITY_250_MILLISECONDS", + "RELAY_CAD_PERIODICITY_100_MILLISECONDS", + "RELAY_CAD_PERIODICITY_50_MILLISECONDS", + "RELAY_CAD_PERIODICITY_20_MILLISECONDS" + ] + }, + "default_channel_index": { + "description": "Index of the default wake on radio channel.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "join_requests": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "notifications": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "overall": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "reset_behavior": { + "type": "string", + "default": "RELAY_RESET_LIMIT_COUNTER_ZERO", + "enum": [ + "RELAY_RESET_LIMIT_COUNTER_ZERO", + "RELAY_RESET_LIMIT_COUNTER_RELOAD_RATE", + "RELAY_RESET_LIMIT_COUNTER_MAX_VALUE", + "RELAY_RESET_LIMIT_COUNTER_NO_RESET" + ] + }, + "uplink_messages": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + } + } + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "uplink_forwarding_rules": { + "description": "Configured uplink forwarding rules.", + "type": "array", + "items": { + "type": "object", + "properties": { + "device_id": { + "description": "End device identifier of the served end device.", + "type": "string" + }, + "last_w_f_cnt": { + "description": "Last wake on radio frame counter used by the served end device.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "session_key_id": { + "description": "Session key ID of the session keys used to derive the root relay session key.", + "type": "string", + "format": "byte" + } + } + } + } + } + } + } + }, + "desired_rx1_data_rate_offset": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_OFFSET_0", + "enum": [ + "DATA_RATE_OFFSET_0", + "DATA_RATE_OFFSET_1", + "DATA_RATE_OFFSET_2", + "DATA_RATE_OFFSET_3", + "DATA_RATE_OFFSET_4", + "DATA_RATE_OFFSET_5", + "DATA_RATE_OFFSET_6", + "DATA_RATE_OFFSET_7" + ] + } + } + }, + "desired_rx1_delay": { + "type": "object", + "properties": { + "value": { + "description": " - RX_DELAY_0: 1 second.\n - RX_DELAY_1: 1 second.\n - RX_DELAY_2: 2 seconds.\n - RX_DELAY_3: 3 seconds.\n - RX_DELAY_4: 4 seconds.\n - RX_DELAY_5: 5 seconds.\n - RX_DELAY_6: 6 seconds.\n - RX_DELAY_7: 7 seconds.\n - RX_DELAY_8: 8 seconds.\n - RX_DELAY_9: 9 seconds.\n - RX_DELAY_10: 10 seconds.\n - RX_DELAY_11: 11 seconds.\n - RX_DELAY_12: 12 seconds.\n - RX_DELAY_13: 13 seconds.\n - RX_DELAY_14: 14 seconds.\n - RX_DELAY_15: 15 seconds.", + "type": "string", + "default": "RX_DELAY_0", + "enum": [ + "RX_DELAY_0", + "RX_DELAY_1", + "RX_DELAY_2", + "RX_DELAY_3", + "RX_DELAY_4", + "RX_DELAY_5", + "RX_DELAY_6", + "RX_DELAY_7", + "RX_DELAY_8", + "RX_DELAY_9", + "RX_DELAY_10", + "RX_DELAY_11", + "RX_DELAY_12", + "RX_DELAY_13", + "RX_DELAY_14", + "RX_DELAY_15" + ] + } + } + }, + "desired_rx2_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "desired_rx2_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "downlink_dwell_time": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "factory_preset_frequencies": { + "description": "List of factory-preset frequencies.\nIf unset, the default value from Network Server configuration or regional parameters specification will be used.", + "type": "array", + "items": { + "type": "string", + "format": "uint64" + } + }, + "max_duty_cycle": { + "type": "object", + "properties": { + "value": { + "description": " - DUTY_CYCLE_1: 100%.\n - DUTY_CYCLE_2: 50%.\n - DUTY_CYCLE_4: 25%.\n - DUTY_CYCLE_8: 12.5%.\n - DUTY_CYCLE_16: 6.25%.\n - DUTY_CYCLE_32: 3.125%.\n - DUTY_CYCLE_64: 1.5625%.\n - DUTY_CYCLE_128: Roughly 0.781%.\n - DUTY_CYCLE_256: Roughly 0.390%.\n - DUTY_CYCLE_512: Roughly 0.195%.\n - DUTY_CYCLE_1024: Roughly 0.098%.\n - DUTY_CYCLE_2048: Roughly 0.049%.\n - DUTY_CYCLE_4096: Roughly 0.024%.\n - DUTY_CYCLE_8192: Roughly 0.012%.\n - DUTY_CYCLE_16384: Roughly 0.006%.\n - DUTY_CYCLE_32768: Roughly 0.003%.", + "type": "string", + "default": "DUTY_CYCLE_1", + "enum": [ + "DUTY_CYCLE_1", + "DUTY_CYCLE_2", + "DUTY_CYCLE_4", + "DUTY_CYCLE_8", + "DUTY_CYCLE_16", + "DUTY_CYCLE_32", + "DUTY_CYCLE_64", + "DUTY_CYCLE_128", + "DUTY_CYCLE_256", + "DUTY_CYCLE_512", + "DUTY_CYCLE_1024", + "DUTY_CYCLE_2048", + "DUTY_CYCLE_4096", + "DUTY_CYCLE_8192", + "DUTY_CYCLE_16384", + "DUTY_CYCLE_32768" + ] + } + } + }, + "ping_slot_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "ping_slot_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "ping_slot_periodicity": { + "type": "object", + "properties": { + "value": { + "description": " - PING_EVERY_1S: Every second.\n - PING_EVERY_2S: Every 2 seconds.\n - PING_EVERY_4S: Every 4 seconds.\n - PING_EVERY_8S: Every 8 seconds.\n - PING_EVERY_16S: Every 16 seconds.\n - PING_EVERY_32S: Every 32 seconds.\n - PING_EVERY_64S: Every 64 seconds.\n - PING_EVERY_128S: Every 128 seconds.", + "type": "string", + "default": "PING_EVERY_1S", + "enum": [ + "PING_EVERY_1S", + "PING_EVERY_2S", + "PING_EVERY_4S", + "PING_EVERY_8S", + "PING_EVERY_16S", + "PING_EVERY_32S", + "PING_EVERY_64S", + "PING_EVERY_128S" + ] + } + } + }, + "relay": { + "description": "RelaySettings represent the settings of a relay.\nThis is used internally by the Network Server.", + "type": "object", + "properties": { + "served": { + "type": "object", + "properties": { + "always": { + "type": "object" + }, + "backoff": { + "description": "Number of wake on radio frames to be sent without an acknowledgement before sending the uplink message directly.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "dynamic": { + "type": "object", + "properties": { + "smart_enable_level": { + "type": "string", + "default": "RELAY_SMART_ENABLE_LEVEL_8", + "enum": [ + "RELAY_SMART_ENABLE_LEVEL_8", + "RELAY_SMART_ENABLE_LEVEL_16", + "RELAY_SMART_ENABLE_LEVEL_32", + "RELAY_SMART_ENABLE_LEVEL_64" + ] + } + } + }, + "end_device_controlled": { + "type": "object" + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "serving_device_id": { + "description": "End device identifier of the serving end device.", + "type": "string" + } + } + }, + "serving": { + "type": "object", + "properties": { + "cad_periodicity": { + "type": "string", + "title": "- RELAY_CAD_PERIODICITY_20_MILLISECONDS: sic", + "default": "RELAY_CAD_PERIODICITY_1_SECOND", + "enum": [ + "RELAY_CAD_PERIODICITY_1_SECOND", + "RELAY_CAD_PERIODICITY_500_MILLISECONDS", + "RELAY_CAD_PERIODICITY_250_MILLISECONDS", + "RELAY_CAD_PERIODICITY_100_MILLISECONDS", + "RELAY_CAD_PERIODICITY_50_MILLISECONDS", + "RELAY_CAD_PERIODICITY_20_MILLISECONDS" + ] + }, + "default_channel_index": { + "description": "Index of the default wake on radio channel.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "join_requests": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "notifications": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "overall": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "reset_behavior": { + "type": "string", + "default": "RELAY_RESET_LIMIT_COUNTER_ZERO", + "enum": [ + "RELAY_RESET_LIMIT_COUNTER_ZERO", + "RELAY_RESET_LIMIT_COUNTER_RELOAD_RATE", + "RELAY_RESET_LIMIT_COUNTER_MAX_VALUE", + "RELAY_RESET_LIMIT_COUNTER_NO_RESET" + ] + }, + "uplink_messages": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + } + } + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "uplink_forwarding_rules": { + "description": "Configured uplink forwarding rules.", + "type": "array", + "items": { + "type": "object", + "properties": { + "device_id": { + "description": "End device identifier of the served end device.", + "type": "string" + }, + "last_w_f_cnt": { + "description": "Last wake on radio frame counter used by the served end device.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "session_key_id": { + "description": "Session key ID of the session keys used to derive the root relay session key.", + "type": "string", + "format": "byte" + } + } + } + } + } + } + } + }, + "resets_f_cnt": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "rx1_data_rate_offset": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_OFFSET_0", + "enum": [ + "DATA_RATE_OFFSET_0", + "DATA_RATE_OFFSET_1", + "DATA_RATE_OFFSET_2", + "DATA_RATE_OFFSET_3", + "DATA_RATE_OFFSET_4", + "DATA_RATE_OFFSET_5", + "DATA_RATE_OFFSET_6", + "DATA_RATE_OFFSET_7" + ] + } + } + }, + "rx1_delay": { + "type": "object", + "properties": { + "value": { + "description": " - RX_DELAY_0: 1 second.\n - RX_DELAY_1: 1 second.\n - RX_DELAY_2: 2 seconds.\n - RX_DELAY_3: 3 seconds.\n - RX_DELAY_4: 4 seconds.\n - RX_DELAY_5: 5 seconds.\n - RX_DELAY_6: 6 seconds.\n - RX_DELAY_7: 7 seconds.\n - RX_DELAY_8: 8 seconds.\n - RX_DELAY_9: 9 seconds.\n - RX_DELAY_10: 10 seconds.\n - RX_DELAY_11: 11 seconds.\n - RX_DELAY_12: 12 seconds.\n - RX_DELAY_13: 13 seconds.\n - RX_DELAY_14: 14 seconds.\n - RX_DELAY_15: 15 seconds.", + "type": "string", + "default": "RX_DELAY_0", + "enum": [ + "RX_DELAY_0", + "RX_DELAY_1", + "RX_DELAY_2", + "RX_DELAY_3", + "RX_DELAY_4", + "RX_DELAY_5", + "RX_DELAY_6", + "RX_DELAY_7", + "RX_DELAY_8", + "RX_DELAY_9", + "RX_DELAY_10", + "RX_DELAY_11", + "RX_DELAY_12", + "RX_DELAY_13", + "RX_DELAY_14", + "RX_DELAY_15" + ] + } + } + }, + "rx2_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "rx2_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "schedule_downlinks": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "status_count_periodicity": { + "description": "Number of uplink messages after which a DevStatusReq MACCommand shall be sent.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "status_time_periodicity": { + "description": "The interval after which a DevStatusReq MACCommand shall be sent.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "supports_32_bit_f_cnt": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "uplink_dwell_time": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "use_adr": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + } + } + } + } + } + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "details": { + "type": "array", + "items": { + "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }", + "type": "object", + "properties": { + "@type": { + "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.", + "type": "string" + } + }, + "additionalProperties": {} + } + }, + "message": { + "type": "string" + } + } + } + } + } + } + }, "/ns/applications/{end_device.ids.application_ids.application_id}/devices": { "post": { "tags": [ @@ -418429,695 +421199,609 @@ } } }, - "/ns/default_mac_settings/{frequency_plan_id}/{lorawan_phy_version}": { - "get": { + "/ns/applications/{mac_settings_profile.ids.application_ids.application_id}/mac_settings_profiles": { + "post": { "tags": [ - "Ns" + "NsMACSettingsProfileRegistry" ], - "summary": "GetDefaultMACSettings retrieves the default MAC settings for a frequency plan.", - "operationId": "Ns_GetDefaultMACSettings", + "summary": "Create creates a new MAC settings profile.", + "operationId": "NsMACSettingsProfileRegistry_Create", "parameters": [ { "type": "string", - "name": "frequency_plan_id", + "name": "mac_settings_profile.ids.application_ids.application_id", "in": "path", "required": true }, { - "enum": [ - "PHY_UNKNOWN", - "PHY_V1_0", - "TS001_V1_0", - "PHY_V1_0_1", - "TS001_V1_0_1", - "PHY_V1_0_2_REV_A", - "RP001_V1_0_2", - "PHY_V1_0_2_REV_B", - "RP001_V1_0_2_REV_B", - "PHY_V1_1_REV_A", - "RP001_V1_1_REV_A", - "PHY_V1_1_REV_B", - "RP001_V1_1_REV_B", - "PHY_V1_0_3_REV_A", - "RP001_V1_0_3_REV_A", - "RP002_V1_0_0", - "RP002_V1_0_1", - "RP002_V1_0_2", - "RP002_V1_0_3", - "RP002_V1_0_4" - ], - "type": "string", - "name": "lorawan_phy_version", - "in": "path", - "required": true - } - ], - "responses": { - "200": { - "description": "A successful response.", + "name": "body", + "in": "body", + "required": true, "schema": { "type": "object", "properties": { - "adr": { - "description": "Adaptive Data Rate settings.", + "mac_settings_profile": { + "description": "The MAC settings profile to create.", "type": "object", + "title": "The MAC settings profile to create.", "properties": { - "disabled": { - "description": "Configuration options for cases in which ADR is to be disabled\ncompletely.", - "type": "object" + "ids": { + "description": "Profile identifiers.", + "type": "object", + "title": "Profile identifiers.", + "properties": { + "application_ids": { + "description": "Application IDs.", + "type": "object", + "title": "Application IDs." + }, + "profile_id": { + "description": "Profile ID.", + "type": "string" + } + } }, - "dynamic": { - "description": "Configuration options for dynamic ADR.", + "mac_settings": { "type": "object", "properties": { - "channel_steering": { - "description": "EXPERIMENTAL: Channel steering settings.", + "adr": { + "description": "Adaptive Data Rate settings.", "type": "object", "properties": { "disabled": { - "description": "Configuration options for cases in which ADR is not supposed to steer the end device\nto another set of channels.", - "type": "object" - }, - "lora_narrow": { - "description": "Configuration options for LoRa narrow channels steering.\nThe narrow mode attempts to steer the end device towards\nusing the LoRa modulated, 125kHz bandwidth channels.", + "description": "Configuration options for cases in which ADR is to be disabled\ncompletely.", "type": "object" - } - } - }, - "margin": { - "description": "The ADR margin (dB) tells the network server how much margin it should add in ADR requests.\nA bigger margin is less efficient, but gives a better chance of successful reception.\nIf unset, the default value from Network Server configuration will be used.", - "type": "number", - "format": "float" - }, - "max_data_rate_index": { - "type": "object", - "properties": { - "value": { - "type": "string", - "default": "DATA_RATE_0", - "enum": [ - "DATA_RATE_0", - "DATA_RATE_1", - "DATA_RATE_2", - "DATA_RATE_3", - "DATA_RATE_4", - "DATA_RATE_5", - "DATA_RATE_6", - "DATA_RATE_7", - "DATA_RATE_8", - "DATA_RATE_9", - "DATA_RATE_10", - "DATA_RATE_11", - "DATA_RATE_12", - "DATA_RATE_13", - "DATA_RATE_14", - "DATA_RATE_15" - ] - } - } - }, - "max_nb_trans": { - "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" - }, - "max_tx_power_index": { - "description": "Maximum transmission power index.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" - }, - "min_data_rate_index": { - "type": "object", - "properties": { - "value": { - "type": "string", - "default": "DATA_RATE_0", - "enum": [ - "DATA_RATE_0", - "DATA_RATE_1", - "DATA_RATE_2", - "DATA_RATE_3", - "DATA_RATE_4", - "DATA_RATE_5", - "DATA_RATE_6", - "DATA_RATE_7", - "DATA_RATE_8", - "DATA_RATE_9", - "DATA_RATE_10", - "DATA_RATE_11", - "DATA_RATE_12", - "DATA_RATE_13", - "DATA_RATE_14", - "DATA_RATE_15" - ] - } - } - }, - "min_nb_trans": { - "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" - }, - "min_tx_power_index": { - "description": "Minimum transmission power index.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" - }, - "overrides": { - "description": "EXPERIMENTAL: Configuration overrides.", - "type": "object", - "properties": { - "data_rate_0": { - "description": "EXPERIMENTAL: Data rate index override settings.", - "type": "object", - "properties": { - "max_nb_trans": { - "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" - }, - "min_nb_trans": { - "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" - } - } - }, - "data_rate_1": { - "description": "EXPERIMENTAL: Data rate index override settings.", - "type": "object", - "properties": { - "max_nb_trans": { - "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" - }, - "min_nb_trans": { - "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" - } - } - }, - "data_rate_10": { - "description": "EXPERIMENTAL: Data rate index override settings.", - "type": "object", - "properties": { - "max_nb_trans": { - "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" - }, - "min_nb_trans": { - "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" - } - } - }, - "data_rate_11": { - "description": "EXPERIMENTAL: Data rate index override settings.", - "type": "object", - "properties": { - "max_nb_trans": { - "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" - }, - "min_nb_trans": { - "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" - } - } - }, - "data_rate_12": { - "description": "EXPERIMENTAL: Data rate index override settings.", - "type": "object", - "properties": { - "max_nb_trans": { - "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" - }, - "min_nb_trans": { - "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" - } - } - }, - "data_rate_13": { - "description": "EXPERIMENTAL: Data rate index override settings.", - "type": "object", - "properties": { - "max_nb_trans": { - "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" - }, - "min_nb_trans": { - "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" - } - } }, - "data_rate_14": { - "description": "EXPERIMENTAL: Data rate index override settings.", + "dynamic": { + "description": "Configuration options for dynamic ADR.", "type": "object", "properties": { - "max_nb_trans": { - "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" + "channel_steering": { + "description": "EXPERIMENTAL: Channel steering settings.", + "type": "object", + "properties": { + "disabled": { + "description": "Configuration options for cases in which ADR is not supposed to steer the end device\nto another set of channels.", + "type": "object" + }, + "lora_narrow": { + "description": "Configuration options for LoRa narrow channels steering.\nThe narrow mode attempts to steer the end device towards\nusing the LoRa modulated, 125kHz bandwidth channels.", + "type": "object" + } + } }, - "min_nb_trans": { - "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" - } - } - }, - "data_rate_15": { - "description": "EXPERIMENTAL: Data rate index override settings.", - "type": "object", - "properties": { - "max_nb_trans": { - "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" + "margin": { + "description": "The ADR margin (dB) tells the network server how much margin it should add in ADR requests.\nA bigger margin is less efficient, but gives a better chance of successful reception.\nIf unset, the default value from Network Server configuration will be used.", + "type": "number", + "format": "float" }, - "min_nb_trans": { - "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" - } - } - }, - "data_rate_2": { - "description": "EXPERIMENTAL: Data rate index override settings.", - "type": "object", - "properties": { - "max_nb_trans": { - "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" + "max_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } }, - "min_nb_trans": { - "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" - } - } - }, - "data_rate_3": { - "description": "EXPERIMENTAL: Data rate index override settings.", - "type": "object", - "properties": { "max_nb_trans": { "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", "type": "integer", "format": "int64" }, - "min_nb_trans": { - "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" - } - } - }, - "data_rate_4": { - "description": "EXPERIMENTAL: Data rate index override settings.", - "type": "object", - "properties": { - "max_nb_trans": { - "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "max_tx_power_index": { + "description": "Maximum transmission power index.\nIf unset, the default value from Network Server configuration will be used.", "type": "integer", "format": "int64" }, - "min_nb_trans": { - "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" - } - } - }, - "data_rate_5": { - "description": "EXPERIMENTAL: Data rate index override settings.", - "type": "object", - "properties": { - "max_nb_trans": { - "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" + "min_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } }, "min_nb_trans": { "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", "type": "integer", "format": "int64" - } - } - }, - "data_rate_6": { - "description": "EXPERIMENTAL: Data rate index override settings.", - "type": "object", - "properties": { - "max_nb_trans": { - "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" }, - "min_nb_trans": { - "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" - } - } - }, - "data_rate_7": { - "description": "EXPERIMENTAL: Data rate index override settings.", - "type": "object", - "properties": { - "max_nb_trans": { - "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "min_tx_power_index": { + "description": "Minimum transmission power index.\nIf unset, the default value from Network Server configuration will be used.", "type": "integer", "format": "int64" }, - "min_nb_trans": { - "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" + "overrides": { + "description": "EXPERIMENTAL: Configuration overrides.", + "type": "object", + "properties": { + "data_rate_0": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_1": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_10": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_11": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_12": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_13": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_14": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_15": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_2": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_3": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_4": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_5": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_6": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_7": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_8": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_9": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + } + } } } }, - "data_rate_8": { - "description": "EXPERIMENTAL: Data rate index override settings.", + "static": { + "description": "Configuration options for static ADR.", "type": "object", "properties": { - "max_nb_trans": { - "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] }, - "min_nb_trans": { - "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" - } - } - }, - "data_rate_9": { - "description": "EXPERIMENTAL: Data rate index override settings.", - "type": "object", - "properties": { - "max_nb_trans": { - "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "nb_trans": { + "description": "Number of retransmissions.", "type": "integer", "format": "int64" }, - "min_nb_trans": { - "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "tx_power_index": { + "description": "Transmission power index to use.", "type": "integer", "format": "int64" } } } } - } - } - }, - "static": { - "description": "Configuration options for static ADR.", - "type": "object", - "properties": { - "data_rate_index": { - "type": "string", - "default": "DATA_RATE_0", - "enum": [ - "DATA_RATE_0", - "DATA_RATE_1", - "DATA_RATE_2", - "DATA_RATE_3", - "DATA_RATE_4", - "DATA_RATE_5", - "DATA_RATE_6", - "DATA_RATE_7", - "DATA_RATE_8", - "DATA_RATE_9", - "DATA_RATE_10", - "DATA_RATE_11", - "DATA_RATE_12", - "DATA_RATE_13", - "DATA_RATE_14", - "DATA_RATE_15" - ] }, - "nb_trans": { - "description": "Number of retransmissions.", - "type": "integer", - "format": "int64" + "adr_margin": { + "description": "The ADR margin (dB) tells the network server how much margin it should add in ADR requests.\nA bigger margin is less efficient, but gives a better chance of successful reception.\nThis field is deprecated, use adr_settings.dynamic.margin instead.", + "type": "number", + "format": "float" }, - "tx_power_index": { - "description": "Transmission power index to use.", - "type": "integer", - "format": "int64" - } - } - } - } - }, - "adr_margin": { - "description": "The ADR margin (dB) tells the network server how much margin it should add in ADR requests.\nA bigger margin is less efficient, but gives a better chance of successful reception.\nThis field is deprecated, use adr_settings.dynamic.margin instead.", - "type": "number", - "format": "float" - }, - "beacon_frequency": { - "type": "object", - "properties": { - "value": { - "type": "string", - "format": "uint64" - } - } - }, - "class_b_c_downlink_interval": { - "description": "The minimum duration passed before a network-initiated(e.g. Class B or C) downlink following an arbitrary downlink.", - "type": "string" - }, - "class_b_timeout": { - "description": "Maximum delay for the device to answer a MAC request or a confirmed downlink frame.\nIf unset, the default value from Network Server configuration will be used.", - "type": "string" - }, - "class_c_timeout": { - "description": "Maximum delay for the device to answer a MAC request or a confirmed downlink frame.\nIf unset, the default value from Network Server configuration will be used.", - "type": "string" - }, - "desired_adr_ack_delay_exponent": { - "type": "object", - "properties": { - "value": { - "type": "string", - "default": "ADR_ACK_DELAY_1", - "enum": [ - "ADR_ACK_DELAY_1", - "ADR_ACK_DELAY_2", - "ADR_ACK_DELAY_4", - "ADR_ACK_DELAY_8", - "ADR_ACK_DELAY_16", - "ADR_ACK_DELAY_32", - "ADR_ACK_DELAY_64", - "ADR_ACK_DELAY_128", - "ADR_ACK_DELAY_256", - "ADR_ACK_DELAY_512", - "ADR_ACK_DELAY_1024", - "ADR_ACK_DELAY_2048", - "ADR_ACK_DELAY_4096", - "ADR_ACK_DELAY_8192", - "ADR_ACK_DELAY_16384", - "ADR_ACK_DELAY_32768" - ] - } - } - }, - "desired_adr_ack_limit_exponent": { - "type": "object", - "properties": { - "value": { - "type": "string", - "default": "ADR_ACK_LIMIT_1", - "enum": [ - "ADR_ACK_LIMIT_1", - "ADR_ACK_LIMIT_2", - "ADR_ACK_LIMIT_4", - "ADR_ACK_LIMIT_8", - "ADR_ACK_LIMIT_16", - "ADR_ACK_LIMIT_32", - "ADR_ACK_LIMIT_64", - "ADR_ACK_LIMIT_128", - "ADR_ACK_LIMIT_256", - "ADR_ACK_LIMIT_512", - "ADR_ACK_LIMIT_1024", - "ADR_ACK_LIMIT_2048", - "ADR_ACK_LIMIT_4096", - "ADR_ACK_LIMIT_8192", - "ADR_ACK_LIMIT_16384", - "ADR_ACK_LIMIT_32768" - ] - } - } - }, - "desired_beacon_frequency": { - "type": "object", - "properties": { - "value": { - "type": "string", - "format": "uint64" - } - } - }, - "desired_max_duty_cycle": { - "type": "object", - "properties": { - "value": { - "description": " - DUTY_CYCLE_1: 100%.\n - DUTY_CYCLE_2: 50%.\n - DUTY_CYCLE_4: 25%.\n - DUTY_CYCLE_8: 12.5%.\n - DUTY_CYCLE_16: 6.25%.\n - DUTY_CYCLE_32: 3.125%.\n - DUTY_CYCLE_64: 1.5625%.\n - DUTY_CYCLE_128: Roughly 0.781%.\n - DUTY_CYCLE_256: Roughly 0.390%.\n - DUTY_CYCLE_512: Roughly 0.195%.\n - DUTY_CYCLE_1024: Roughly 0.098%.\n - DUTY_CYCLE_2048: Roughly 0.049%.\n - DUTY_CYCLE_4096: Roughly 0.024%.\n - DUTY_CYCLE_8192: Roughly 0.012%.\n - DUTY_CYCLE_16384: Roughly 0.006%.\n - DUTY_CYCLE_32768: Roughly 0.003%.", - "type": "string", - "default": "DUTY_CYCLE_1", - "enum": [ - "DUTY_CYCLE_1", - "DUTY_CYCLE_2", - "DUTY_CYCLE_4", - "DUTY_CYCLE_8", - "DUTY_CYCLE_16", - "DUTY_CYCLE_32", - "DUTY_CYCLE_64", - "DUTY_CYCLE_128", - "DUTY_CYCLE_256", - "DUTY_CYCLE_512", - "DUTY_CYCLE_1024", - "DUTY_CYCLE_2048", - "DUTY_CYCLE_4096", - "DUTY_CYCLE_8192", - "DUTY_CYCLE_16384", - "DUTY_CYCLE_32768" - ] - } - } - }, - "desired_max_eirp": { - "type": "object", - "properties": { - "value": { - "description": " - DEVICE_EIRP_8: 8 dBm.\n - DEVICE_EIRP_10: 10 dBm.\n - DEVICE_EIRP_12: 12 dBm.\n - DEVICE_EIRP_13: 13 dBm.\n - DEVICE_EIRP_14: 14 dBm.\n - DEVICE_EIRP_16: 16 dBm.\n - DEVICE_EIRP_18: 18 dBm.\n - DEVICE_EIRP_20: 20 dBm.\n - DEVICE_EIRP_21: 21 dBm.\n - DEVICE_EIRP_24: 24 dBm.\n - DEVICE_EIRP_26: 26 dBm.\n - DEVICE_EIRP_27: 27 dBm.\n - DEVICE_EIRP_29: 29 dBm.\n - DEVICE_EIRP_30: 30 dBm.\n - DEVICE_EIRP_33: 33 dBm.\n - DEVICE_EIRP_36: 36 dBm.", - "type": "string", - "default": "DEVICE_EIRP_8", - "enum": [ - "DEVICE_EIRP_8", - "DEVICE_EIRP_10", - "DEVICE_EIRP_12", - "DEVICE_EIRP_13", - "DEVICE_EIRP_14", - "DEVICE_EIRP_16", - "DEVICE_EIRP_18", - "DEVICE_EIRP_20", - "DEVICE_EIRP_21", - "DEVICE_EIRP_24", - "DEVICE_EIRP_26", - "DEVICE_EIRP_27", - "DEVICE_EIRP_29", - "DEVICE_EIRP_30", - "DEVICE_EIRP_33", - "DEVICE_EIRP_36" - ] - } - } - }, - "desired_ping_slot_data_rate_index": { - "type": "object", - "properties": { - "value": { - "type": "string", - "default": "DATA_RATE_0", - "enum": [ - "DATA_RATE_0", - "DATA_RATE_1", - "DATA_RATE_2", - "DATA_RATE_3", - "DATA_RATE_4", - "DATA_RATE_5", - "DATA_RATE_6", - "DATA_RATE_7", - "DATA_RATE_8", - "DATA_RATE_9", - "DATA_RATE_10", - "DATA_RATE_11", - "DATA_RATE_12", - "DATA_RATE_13", - "DATA_RATE_14", - "DATA_RATE_15" - ] - } - } - }, - "desired_ping_slot_frequency": { - "type": "object", - "properties": { - "value": { - "type": "string", - "format": "uint64" - } - } - }, - "desired_relay": { - "description": "RelaySettings represent the settings of a relay.\nThis is used internally by the Network Server.", - "type": "object", - "properties": { - "served": { - "type": "object", - "properties": { - "always": { - "type": "object" + "beacon_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } }, - "backoff": { - "description": "Number of wake on radio frames to be sent without an acknowledgement before sending the uplink message directly.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" + "class_b_c_downlink_interval": { + "description": "The minimum duration passed before a network-initiated(e.g. Class B or C) downlink following an arbitrary downlink.", + "type": "string" }, - "dynamic": { + "class_b_timeout": { + "description": "Maximum delay for the device to answer a MAC request or a confirmed downlink frame.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "class_c_timeout": { + "description": "Maximum delay for the device to answer a MAC request or a confirmed downlink frame.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "desired_adr_ack_delay_exponent": { "type": "object", "properties": { - "smart_enable_level": { + "value": { "type": "string", - "default": "RELAY_SMART_ENABLE_LEVEL_8", + "default": "ADR_ACK_DELAY_1", "enum": [ - "RELAY_SMART_ENABLE_LEVEL_8", - "RELAY_SMART_ENABLE_LEVEL_16", - "RELAY_SMART_ENABLE_LEVEL_32", - "RELAY_SMART_ENABLE_LEVEL_64" + "ADR_ACK_DELAY_1", + "ADR_ACK_DELAY_2", + "ADR_ACK_DELAY_4", + "ADR_ACK_DELAY_8", + "ADR_ACK_DELAY_16", + "ADR_ACK_DELAY_32", + "ADR_ACK_DELAY_64", + "ADR_ACK_DELAY_128", + "ADR_ACK_DELAY_256", + "ADR_ACK_DELAY_512", + "ADR_ACK_DELAY_1024", + "ADR_ACK_DELAY_2048", + "ADR_ACK_DELAY_4096", + "ADR_ACK_DELAY_8192", + "ADR_ACK_DELAY_16384", + "ADR_ACK_DELAY_32768" ] } } }, - "end_device_controlled": { - "type": "object" + "desired_adr_ack_limit_exponent": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "ADR_ACK_LIMIT_1", + "enum": [ + "ADR_ACK_LIMIT_1", + "ADR_ACK_LIMIT_2", + "ADR_ACK_LIMIT_4", + "ADR_ACK_LIMIT_8", + "ADR_ACK_LIMIT_16", + "ADR_ACK_LIMIT_32", + "ADR_ACK_LIMIT_64", + "ADR_ACK_LIMIT_128", + "ADR_ACK_LIMIT_256", + "ADR_ACK_LIMIT_512", + "ADR_ACK_LIMIT_1024", + "ADR_ACK_LIMIT_2048", + "ADR_ACK_LIMIT_4096", + "ADR_ACK_LIMIT_8192", + "ADR_ACK_LIMIT_16384", + "ADR_ACK_LIMIT_32768" + ] + } + } }, - "second_channel": { + "desired_beacon_frequency": { "type": "object", "properties": { - "ack_offset": { + "value": { "type": "string", - "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", - "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "format": "uint64" + } + } + }, + "desired_max_duty_cycle": { + "type": "object", + "properties": { + "value": { + "description": " - DUTY_CYCLE_1: 100%.\n - DUTY_CYCLE_2: 50%.\n - DUTY_CYCLE_4: 25%.\n - DUTY_CYCLE_8: 12.5%.\n - DUTY_CYCLE_16: 6.25%.\n - DUTY_CYCLE_32: 3.125%.\n - DUTY_CYCLE_64: 1.5625%.\n - DUTY_CYCLE_128: Roughly 0.781%.\n - DUTY_CYCLE_256: Roughly 0.390%.\n - DUTY_CYCLE_512: Roughly 0.195%.\n - DUTY_CYCLE_1024: Roughly 0.098%.\n - DUTY_CYCLE_2048: Roughly 0.049%.\n - DUTY_CYCLE_4096: Roughly 0.024%.\n - DUTY_CYCLE_8192: Roughly 0.012%.\n - DUTY_CYCLE_16384: Roughly 0.006%.\n - DUTY_CYCLE_32768: Roughly 0.003%.", + "type": "string", + "default": "DUTY_CYCLE_1", "enum": [ - "RELAY_SECOND_CH_ACK_OFFSET_0", - "RELAY_SECOND_CH_ACK_OFFSET_200", - "RELAY_SECOND_CH_ACK_OFFSET_400", - "RELAY_SECOND_CH_ACK_OFFSET_800", - "RELAY_SECOND_CH_ACK_OFFSET_1600", - "RELAY_SECOND_CH_ACK_OFFSET_3200" + "DUTY_CYCLE_1", + "DUTY_CYCLE_2", + "DUTY_CYCLE_4", + "DUTY_CYCLE_8", + "DUTY_CYCLE_16", + "DUTY_CYCLE_32", + "DUTY_CYCLE_64", + "DUTY_CYCLE_128", + "DUTY_CYCLE_256", + "DUTY_CYCLE_512", + "DUTY_CYCLE_1024", + "DUTY_CYCLE_2048", + "DUTY_CYCLE_4096", + "DUTY_CYCLE_8192", + "DUTY_CYCLE_16384", + "DUTY_CYCLE_32768" ] - }, - "data_rate_index": { + } + } + }, + "desired_max_eirp": { + "type": "object", + "properties": { + "value": { + "description": " - DEVICE_EIRP_8: 8 dBm.\n - DEVICE_EIRP_10: 10 dBm.\n - DEVICE_EIRP_12: 12 dBm.\n - DEVICE_EIRP_13: 13 dBm.\n - DEVICE_EIRP_14: 14 dBm.\n - DEVICE_EIRP_16: 16 dBm.\n - DEVICE_EIRP_18: 18 dBm.\n - DEVICE_EIRP_20: 20 dBm.\n - DEVICE_EIRP_21: 21 dBm.\n - DEVICE_EIRP_24: 24 dBm.\n - DEVICE_EIRP_26: 26 dBm.\n - DEVICE_EIRP_27: 27 dBm.\n - DEVICE_EIRP_29: 29 dBm.\n - DEVICE_EIRP_30: 30 dBm.\n - DEVICE_EIRP_33: 33 dBm.\n - DEVICE_EIRP_36: 36 dBm.", + "type": "string", + "default": "DEVICE_EIRP_8", + "enum": [ + "DEVICE_EIRP_8", + "DEVICE_EIRP_10", + "DEVICE_EIRP_12", + "DEVICE_EIRP_13", + "DEVICE_EIRP_14", + "DEVICE_EIRP_16", + "DEVICE_EIRP_18", + "DEVICE_EIRP_20", + "DEVICE_EIRP_21", + "DEVICE_EIRP_24", + "DEVICE_EIRP_26", + "DEVICE_EIRP_27", + "DEVICE_EIRP_29", + "DEVICE_EIRP_30", + "DEVICE_EIRP_33", + "DEVICE_EIRP_36" + ] + } + } + }, + "desired_ping_slot_data_rate_index": { + "type": "object", + "properties": { + "value": { "type": "string", "default": "DATA_RATE_0", "enum": [ @@ -419138,157 +421822,366 @@ "DATA_RATE_14", "DATA_RATE_15" ] - }, - "frequency": { - "description": "The frequency (Hz) used by the wake on radio message.", + } + } + }, + "desired_ping_slot_frequency": { + "type": "object", + "properties": { + "value": { "type": "string", "format": "uint64" } } }, - "serving_device_id": { - "description": "End device identifier of the serving end device.", - "type": "string" - } - } - }, - "serving": { - "type": "object", - "properties": { - "cad_periodicity": { - "type": "string", - "title": "- RELAY_CAD_PERIODICITY_20_MILLISECONDS: sic", - "default": "RELAY_CAD_PERIODICITY_1_SECOND", - "enum": [ - "RELAY_CAD_PERIODICITY_1_SECOND", - "RELAY_CAD_PERIODICITY_500_MILLISECONDS", - "RELAY_CAD_PERIODICITY_250_MILLISECONDS", - "RELAY_CAD_PERIODICITY_100_MILLISECONDS", - "RELAY_CAD_PERIODICITY_50_MILLISECONDS", - "RELAY_CAD_PERIODICITY_20_MILLISECONDS" - ] - }, - "default_channel_index": { - "description": "Index of the default wake on radio channel.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" - }, - "limits": { + "desired_relay": { + "description": "RelaySettings represent the settings of a relay.\nThis is used internally by the Network Server.", "type": "object", "properties": { - "join_requests": { + "served": { "type": "object", "properties": { - "bucket_size": { - "type": "string", - "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", - "default": "RELAY_LIMIT_BUCKET_SIZE_1", - "enum": [ - "RELAY_LIMIT_BUCKET_SIZE_1", - "RELAY_LIMIT_BUCKET_SIZE_2", - "RELAY_LIMIT_BUCKET_SIZE_4", - "RELAY_LIMIT_BUCKET_SIZE_12" - ] + "always": { + "type": "object" }, - "reload_rate": { - "description": "The number of tokens which are replenished in the bucket every hour.", + "backoff": { + "description": "Number of wake on radio frames to be sent without an acknowledgement before sending the uplink message directly.\nIf unset, the default value from Network Server configuration will be used.", "type": "integer", "format": "int64" - } - } - }, - "notifications": { - "type": "object", - "properties": { - "bucket_size": { - "type": "string", - "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", - "default": "RELAY_LIMIT_BUCKET_SIZE_1", - "enum": [ - "RELAY_LIMIT_BUCKET_SIZE_1", - "RELAY_LIMIT_BUCKET_SIZE_2", - "RELAY_LIMIT_BUCKET_SIZE_4", - "RELAY_LIMIT_BUCKET_SIZE_12" - ] }, - "reload_rate": { - "description": "The number of tokens which are replenished in the bucket every hour.", - "type": "integer", - "format": "int64" + "dynamic": { + "type": "object", + "properties": { + "smart_enable_level": { + "type": "string", + "default": "RELAY_SMART_ENABLE_LEVEL_8", + "enum": [ + "RELAY_SMART_ENABLE_LEVEL_8", + "RELAY_SMART_ENABLE_LEVEL_16", + "RELAY_SMART_ENABLE_LEVEL_32", + "RELAY_SMART_ENABLE_LEVEL_64" + ] + } + } + }, + "end_device_controlled": { + "type": "object" + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "serving_device_id": { + "description": "End device identifier of the serving end device.", + "type": "string" } } }, - "overall": { + "serving": { "type": "object", "properties": { - "bucket_size": { + "cad_periodicity": { "type": "string", - "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", - "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "title": "- RELAY_CAD_PERIODICITY_20_MILLISECONDS: sic", + "default": "RELAY_CAD_PERIODICITY_1_SECOND", "enum": [ - "RELAY_LIMIT_BUCKET_SIZE_1", - "RELAY_LIMIT_BUCKET_SIZE_2", - "RELAY_LIMIT_BUCKET_SIZE_4", - "RELAY_LIMIT_BUCKET_SIZE_12" + "RELAY_CAD_PERIODICITY_1_SECOND", + "RELAY_CAD_PERIODICITY_500_MILLISECONDS", + "RELAY_CAD_PERIODICITY_250_MILLISECONDS", + "RELAY_CAD_PERIODICITY_100_MILLISECONDS", + "RELAY_CAD_PERIODICITY_50_MILLISECONDS", + "RELAY_CAD_PERIODICITY_20_MILLISECONDS" ] }, - "reload_rate": { - "description": "The number of tokens which are replenished in the bucket every hour.", + "default_channel_index": { + "description": "Index of the default wake on radio channel.\nIf unset, the default value from Network Server configuration will be used.", "type": "integer", "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "join_requests": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "notifications": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "overall": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "reset_behavior": { + "type": "string", + "default": "RELAY_RESET_LIMIT_COUNTER_ZERO", + "enum": [ + "RELAY_RESET_LIMIT_COUNTER_ZERO", + "RELAY_RESET_LIMIT_COUNTER_RELOAD_RATE", + "RELAY_RESET_LIMIT_COUNTER_MAX_VALUE", + "RELAY_RESET_LIMIT_COUNTER_NO_RESET" + ] + }, + "uplink_messages": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + } + } + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "uplink_forwarding_rules": { + "description": "Configured uplink forwarding rules.", + "type": "array", + "items": { + "type": "object", + "properties": { + "device_id": { + "description": "End device identifier of the served end device.", + "type": "string" + }, + "last_w_f_cnt": { + "description": "Last wake on radio frame counter used by the served end device.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "session_key_id": { + "description": "Session key ID of the session keys used to derive the root relay session key.", + "type": "string", + "format": "byte" + } + } + } } } - }, - "reset_behavior": { + } + } + }, + "desired_rx1_data_rate_offset": { + "type": "object", + "properties": { + "value": { "type": "string", - "default": "RELAY_RESET_LIMIT_COUNTER_ZERO", + "default": "DATA_RATE_OFFSET_0", "enum": [ - "RELAY_RESET_LIMIT_COUNTER_ZERO", - "RELAY_RESET_LIMIT_COUNTER_RELOAD_RATE", - "RELAY_RESET_LIMIT_COUNTER_MAX_VALUE", - "RELAY_RESET_LIMIT_COUNTER_NO_RESET" + "DATA_RATE_OFFSET_0", + "DATA_RATE_OFFSET_1", + "DATA_RATE_OFFSET_2", + "DATA_RATE_OFFSET_3", + "DATA_RATE_OFFSET_4", + "DATA_RATE_OFFSET_5", + "DATA_RATE_OFFSET_6", + "DATA_RATE_OFFSET_7" ] - }, - "uplink_messages": { - "type": "object", - "properties": { - "bucket_size": { - "type": "string", - "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", - "default": "RELAY_LIMIT_BUCKET_SIZE_1", - "enum": [ - "RELAY_LIMIT_BUCKET_SIZE_1", - "RELAY_LIMIT_BUCKET_SIZE_2", - "RELAY_LIMIT_BUCKET_SIZE_4", - "RELAY_LIMIT_BUCKET_SIZE_12" - ] - }, - "reload_rate": { - "description": "The number of tokens which are replenished in the bucket every hour.", - "type": "integer", - "format": "int64" - } - } } } }, - "second_channel": { + "desired_rx1_delay": { "type": "object", "properties": { - "ack_offset": { + "value": { + "description": " - RX_DELAY_0: 1 second.\n - RX_DELAY_1: 1 second.\n - RX_DELAY_2: 2 seconds.\n - RX_DELAY_3: 3 seconds.\n - RX_DELAY_4: 4 seconds.\n - RX_DELAY_5: 5 seconds.\n - RX_DELAY_6: 6 seconds.\n - RX_DELAY_7: 7 seconds.\n - RX_DELAY_8: 8 seconds.\n - RX_DELAY_9: 9 seconds.\n - RX_DELAY_10: 10 seconds.\n - RX_DELAY_11: 11 seconds.\n - RX_DELAY_12: 12 seconds.\n - RX_DELAY_13: 13 seconds.\n - RX_DELAY_14: 14 seconds.\n - RX_DELAY_15: 15 seconds.", "type": "string", - "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", - "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "default": "RX_DELAY_0", "enum": [ - "RELAY_SECOND_CH_ACK_OFFSET_0", - "RELAY_SECOND_CH_ACK_OFFSET_200", - "RELAY_SECOND_CH_ACK_OFFSET_400", - "RELAY_SECOND_CH_ACK_OFFSET_800", - "RELAY_SECOND_CH_ACK_OFFSET_1600", - "RELAY_SECOND_CH_ACK_OFFSET_3200" + "RX_DELAY_0", + "RX_DELAY_1", + "RX_DELAY_2", + "RX_DELAY_3", + "RX_DELAY_4", + "RX_DELAY_5", + "RX_DELAY_6", + "RX_DELAY_7", + "RX_DELAY_8", + "RX_DELAY_9", + "RX_DELAY_10", + "RX_DELAY_11", + "RX_DELAY_12", + "RX_DELAY_13", + "RX_DELAY_14", + "RX_DELAY_15" ] - }, - "data_rate_index": { + } + } + }, + "desired_rx2_data_rate_index": { + "type": "object", + "properties": { + "value": { "type": "string", "default": "DATA_RATE_0", "enum": [ @@ -419309,295 +422202,66 @@ "DATA_RATE_14", "DATA_RATE_15" ] - }, - "frequency": { - "description": "The frequency (Hz) used by the wake on radio message.", + } + } + }, + "desired_rx2_frequency": { + "type": "object", + "properties": { + "value": { "type": "string", "format": "uint64" } } }, - "uplink_forwarding_rules": { - "description": "Configured uplink forwarding rules.", - "type": "array", - "items": { - "type": "object", - "properties": { - "device_id": { - "description": "End device identifier of the served end device.", - "type": "string" - }, - "last_w_f_cnt": { - "description": "Last wake on radio frame counter used by the served end device.", - "type": "integer", - "format": "int64" - }, - "limits": { - "type": "object", - "properties": { - "bucket_size": { - "type": "string", - "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", - "default": "RELAY_LIMIT_BUCKET_SIZE_1", - "enum": [ - "RELAY_LIMIT_BUCKET_SIZE_1", - "RELAY_LIMIT_BUCKET_SIZE_2", - "RELAY_LIMIT_BUCKET_SIZE_4", - "RELAY_LIMIT_BUCKET_SIZE_12" - ] - }, - "reload_rate": { - "description": "The number of tokens which are replenished in the bucket every hour.", - "type": "integer", - "format": "int64" - } - } - }, - "session_key_id": { - "description": "Session key ID of the session keys used to derive the root relay session key.", - "type": "string", - "format": "byte" - } + "downlink_dwell_time": { + "type": "object", + "properties": { + "value": { + "type": "boolean" } } - } - } - } - } - }, - "desired_rx1_data_rate_offset": { - "type": "object", - "properties": { - "value": { - "type": "string", - "default": "DATA_RATE_OFFSET_0", - "enum": [ - "DATA_RATE_OFFSET_0", - "DATA_RATE_OFFSET_1", - "DATA_RATE_OFFSET_2", - "DATA_RATE_OFFSET_3", - "DATA_RATE_OFFSET_4", - "DATA_RATE_OFFSET_5", - "DATA_RATE_OFFSET_6", - "DATA_RATE_OFFSET_7" - ] - } - } - }, - "desired_rx1_delay": { - "type": "object", - "properties": { - "value": { - "description": " - RX_DELAY_0: 1 second.\n - RX_DELAY_1: 1 second.\n - RX_DELAY_2: 2 seconds.\n - RX_DELAY_3: 3 seconds.\n - RX_DELAY_4: 4 seconds.\n - RX_DELAY_5: 5 seconds.\n - RX_DELAY_6: 6 seconds.\n - RX_DELAY_7: 7 seconds.\n - RX_DELAY_8: 8 seconds.\n - RX_DELAY_9: 9 seconds.\n - RX_DELAY_10: 10 seconds.\n - RX_DELAY_11: 11 seconds.\n - RX_DELAY_12: 12 seconds.\n - RX_DELAY_13: 13 seconds.\n - RX_DELAY_14: 14 seconds.\n - RX_DELAY_15: 15 seconds.", - "type": "string", - "default": "RX_DELAY_0", - "enum": [ - "RX_DELAY_0", - "RX_DELAY_1", - "RX_DELAY_2", - "RX_DELAY_3", - "RX_DELAY_4", - "RX_DELAY_5", - "RX_DELAY_6", - "RX_DELAY_7", - "RX_DELAY_8", - "RX_DELAY_9", - "RX_DELAY_10", - "RX_DELAY_11", - "RX_DELAY_12", - "RX_DELAY_13", - "RX_DELAY_14", - "RX_DELAY_15" - ] - } - } - }, - "desired_rx2_data_rate_index": { - "type": "object", - "properties": { - "value": { - "type": "string", - "default": "DATA_RATE_0", - "enum": [ - "DATA_RATE_0", - "DATA_RATE_1", - "DATA_RATE_2", - "DATA_RATE_3", - "DATA_RATE_4", - "DATA_RATE_5", - "DATA_RATE_6", - "DATA_RATE_7", - "DATA_RATE_8", - "DATA_RATE_9", - "DATA_RATE_10", - "DATA_RATE_11", - "DATA_RATE_12", - "DATA_RATE_13", - "DATA_RATE_14", - "DATA_RATE_15" - ] - } - } - }, - "desired_rx2_frequency": { - "type": "object", - "properties": { - "value": { - "type": "string", - "format": "uint64" - } - } - }, - "downlink_dwell_time": { - "type": "object", - "properties": { - "value": { - "type": "boolean" - } - } - }, - "factory_preset_frequencies": { - "description": "List of factory-preset frequencies.\nIf unset, the default value from Network Server configuration or regional parameters specification will be used.", - "type": "array", - "items": { - "type": "string", - "format": "uint64" - } - }, - "max_duty_cycle": { - "type": "object", - "properties": { - "value": { - "description": " - DUTY_CYCLE_1: 100%.\n - DUTY_CYCLE_2: 50%.\n - DUTY_CYCLE_4: 25%.\n - DUTY_CYCLE_8: 12.5%.\n - DUTY_CYCLE_16: 6.25%.\n - DUTY_CYCLE_32: 3.125%.\n - DUTY_CYCLE_64: 1.5625%.\n - DUTY_CYCLE_128: Roughly 0.781%.\n - DUTY_CYCLE_256: Roughly 0.390%.\n - DUTY_CYCLE_512: Roughly 0.195%.\n - DUTY_CYCLE_1024: Roughly 0.098%.\n - DUTY_CYCLE_2048: Roughly 0.049%.\n - DUTY_CYCLE_4096: Roughly 0.024%.\n - DUTY_CYCLE_8192: Roughly 0.012%.\n - DUTY_CYCLE_16384: Roughly 0.006%.\n - DUTY_CYCLE_32768: Roughly 0.003%.", - "type": "string", - "default": "DUTY_CYCLE_1", - "enum": [ - "DUTY_CYCLE_1", - "DUTY_CYCLE_2", - "DUTY_CYCLE_4", - "DUTY_CYCLE_8", - "DUTY_CYCLE_16", - "DUTY_CYCLE_32", - "DUTY_CYCLE_64", - "DUTY_CYCLE_128", - "DUTY_CYCLE_256", - "DUTY_CYCLE_512", - "DUTY_CYCLE_1024", - "DUTY_CYCLE_2048", - "DUTY_CYCLE_4096", - "DUTY_CYCLE_8192", - "DUTY_CYCLE_16384", - "DUTY_CYCLE_32768" - ] - } - } - }, - "ping_slot_data_rate_index": { - "type": "object", - "properties": { - "value": { - "type": "string", - "default": "DATA_RATE_0", - "enum": [ - "DATA_RATE_0", - "DATA_RATE_1", - "DATA_RATE_2", - "DATA_RATE_3", - "DATA_RATE_4", - "DATA_RATE_5", - "DATA_RATE_6", - "DATA_RATE_7", - "DATA_RATE_8", - "DATA_RATE_9", - "DATA_RATE_10", - "DATA_RATE_11", - "DATA_RATE_12", - "DATA_RATE_13", - "DATA_RATE_14", - "DATA_RATE_15" - ] - } - } - }, - "ping_slot_frequency": { - "type": "object", - "properties": { - "value": { - "type": "string", - "format": "uint64" - } - } - }, - "ping_slot_periodicity": { - "type": "object", - "properties": { - "value": { - "description": " - PING_EVERY_1S: Every second.\n - PING_EVERY_2S: Every 2 seconds.\n - PING_EVERY_4S: Every 4 seconds.\n - PING_EVERY_8S: Every 8 seconds.\n - PING_EVERY_16S: Every 16 seconds.\n - PING_EVERY_32S: Every 32 seconds.\n - PING_EVERY_64S: Every 64 seconds.\n - PING_EVERY_128S: Every 128 seconds.", - "type": "string", - "default": "PING_EVERY_1S", - "enum": [ - "PING_EVERY_1S", - "PING_EVERY_2S", - "PING_EVERY_4S", - "PING_EVERY_8S", - "PING_EVERY_16S", - "PING_EVERY_32S", - "PING_EVERY_64S", - "PING_EVERY_128S" - ] - } - } - }, - "relay": { - "description": "RelaySettings represent the settings of a relay.\nThis is used internally by the Network Server.", - "type": "object", - "properties": { - "served": { - "type": "object", - "properties": { - "always": { - "type": "object" }, - "backoff": { - "description": "Number of wake on radio frames to be sent without an acknowledgement before sending the uplink message directly.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" + "factory_preset_frequencies": { + "description": "List of factory-preset frequencies.\nIf unset, the default value from Network Server configuration or regional parameters specification will be used.", + "type": "array", + "items": { + "type": "string", + "format": "uint64" + } }, - "dynamic": { + "max_duty_cycle": { "type": "object", "properties": { - "smart_enable_level": { + "value": { + "description": " - DUTY_CYCLE_1: 100%.\n - DUTY_CYCLE_2: 50%.\n - DUTY_CYCLE_4: 25%.\n - DUTY_CYCLE_8: 12.5%.\n - DUTY_CYCLE_16: 6.25%.\n - DUTY_CYCLE_32: 3.125%.\n - DUTY_CYCLE_64: 1.5625%.\n - DUTY_CYCLE_128: Roughly 0.781%.\n - DUTY_CYCLE_256: Roughly 0.390%.\n - DUTY_CYCLE_512: Roughly 0.195%.\n - DUTY_CYCLE_1024: Roughly 0.098%.\n - DUTY_CYCLE_2048: Roughly 0.049%.\n - DUTY_CYCLE_4096: Roughly 0.024%.\n - DUTY_CYCLE_8192: Roughly 0.012%.\n - DUTY_CYCLE_16384: Roughly 0.006%.\n - DUTY_CYCLE_32768: Roughly 0.003%.", "type": "string", - "default": "RELAY_SMART_ENABLE_LEVEL_8", + "default": "DUTY_CYCLE_1", "enum": [ - "RELAY_SMART_ENABLE_LEVEL_8", - "RELAY_SMART_ENABLE_LEVEL_16", - "RELAY_SMART_ENABLE_LEVEL_32", - "RELAY_SMART_ENABLE_LEVEL_64" + "DUTY_CYCLE_1", + "DUTY_CYCLE_2", + "DUTY_CYCLE_4", + "DUTY_CYCLE_8", + "DUTY_CYCLE_16", + "DUTY_CYCLE_32", + "DUTY_CYCLE_64", + "DUTY_CYCLE_128", + "DUTY_CYCLE_256", + "DUTY_CYCLE_512", + "DUTY_CYCLE_1024", + "DUTY_CYCLE_2048", + "DUTY_CYCLE_4096", + "DUTY_CYCLE_8192", + "DUTY_CYCLE_16384", + "DUTY_CYCLE_32768" ] } } }, - "end_device_controlled": { - "type": "object" - }, - "second_channel": { + "ping_slot_data_rate_index": { "type": "object", "properties": { - "ack_offset": { - "type": "string", - "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", - "default": "RELAY_SECOND_CH_ACK_OFFSET_0", - "enum": [ - "RELAY_SECOND_CH_ACK_OFFSET_0", - "RELAY_SECOND_CH_ACK_OFFSET_200", - "RELAY_SECOND_CH_ACK_OFFSET_400", - "RELAY_SECOND_CH_ACK_OFFSET_800", - "RELAY_SECOND_CH_ACK_OFFSET_1600", - "RELAY_SECOND_CH_ACK_OFFSET_3200" - ] - }, - "data_rate_index": { + "value": { "type": "string", "default": "DATA_RATE_0", "enum": [ @@ -419618,157 +422282,1442 @@ "DATA_RATE_14", "DATA_RATE_15" ] - }, - "frequency": { - "description": "The frequency (Hz) used by the wake on radio message.", + } + } + }, + "ping_slot_frequency": { + "type": "object", + "properties": { + "value": { "type": "string", "format": "uint64" } } }, - "serving_device_id": { - "description": "End device identifier of the serving end device.", - "type": "string" - } - } - }, - "serving": { - "type": "object", - "properties": { - "cad_periodicity": { - "type": "string", - "title": "- RELAY_CAD_PERIODICITY_20_MILLISECONDS: sic", - "default": "RELAY_CAD_PERIODICITY_1_SECOND", - "enum": [ - "RELAY_CAD_PERIODICITY_1_SECOND", - "RELAY_CAD_PERIODICITY_500_MILLISECONDS", - "RELAY_CAD_PERIODICITY_250_MILLISECONDS", - "RELAY_CAD_PERIODICITY_100_MILLISECONDS", - "RELAY_CAD_PERIODICITY_50_MILLISECONDS", - "RELAY_CAD_PERIODICITY_20_MILLISECONDS" - ] - }, - "default_channel_index": { - "description": "Index of the default wake on radio channel.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" + "ping_slot_periodicity": { + "type": "object", + "properties": { + "value": { + "description": " - PING_EVERY_1S: Every second.\n - PING_EVERY_2S: Every 2 seconds.\n - PING_EVERY_4S: Every 4 seconds.\n - PING_EVERY_8S: Every 8 seconds.\n - PING_EVERY_16S: Every 16 seconds.\n - PING_EVERY_32S: Every 32 seconds.\n - PING_EVERY_64S: Every 64 seconds.\n - PING_EVERY_128S: Every 128 seconds.", + "type": "string", + "default": "PING_EVERY_1S", + "enum": [ + "PING_EVERY_1S", + "PING_EVERY_2S", + "PING_EVERY_4S", + "PING_EVERY_8S", + "PING_EVERY_16S", + "PING_EVERY_32S", + "PING_EVERY_64S", + "PING_EVERY_128S" + ] + } + } }, - "limits": { + "relay": { + "description": "RelaySettings represent the settings of a relay.\nThis is used internally by the Network Server.", "type": "object", "properties": { - "join_requests": { + "served": { "type": "object", "properties": { - "bucket_size": { - "type": "string", - "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", - "default": "RELAY_LIMIT_BUCKET_SIZE_1", - "enum": [ - "RELAY_LIMIT_BUCKET_SIZE_1", - "RELAY_LIMIT_BUCKET_SIZE_2", - "RELAY_LIMIT_BUCKET_SIZE_4", - "RELAY_LIMIT_BUCKET_SIZE_12" - ] + "always": { + "type": "object" }, - "reload_rate": { - "description": "The number of tokens which are replenished in the bucket every hour.", + "backoff": { + "description": "Number of wake on radio frames to be sent without an acknowledgement before sending the uplink message directly.\nIf unset, the default value from Network Server configuration will be used.", "type": "integer", "format": "int64" + }, + "dynamic": { + "type": "object", + "properties": { + "smart_enable_level": { + "type": "string", + "default": "RELAY_SMART_ENABLE_LEVEL_8", + "enum": [ + "RELAY_SMART_ENABLE_LEVEL_8", + "RELAY_SMART_ENABLE_LEVEL_16", + "RELAY_SMART_ENABLE_LEVEL_32", + "RELAY_SMART_ENABLE_LEVEL_64" + ] + } + } + }, + "end_device_controlled": { + "type": "object" + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "serving_device_id": { + "description": "End device identifier of the serving end device.", + "type": "string" } } }, - "notifications": { + "serving": { "type": "object", "properties": { - "bucket_size": { + "cad_periodicity": { "type": "string", - "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", - "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "title": "- RELAY_CAD_PERIODICITY_20_MILLISECONDS: sic", + "default": "RELAY_CAD_PERIODICITY_1_SECOND", "enum": [ - "RELAY_LIMIT_BUCKET_SIZE_1", - "RELAY_LIMIT_BUCKET_SIZE_2", - "RELAY_LIMIT_BUCKET_SIZE_4", - "RELAY_LIMIT_BUCKET_SIZE_12" + "RELAY_CAD_PERIODICITY_1_SECOND", + "RELAY_CAD_PERIODICITY_500_MILLISECONDS", + "RELAY_CAD_PERIODICITY_250_MILLISECONDS", + "RELAY_CAD_PERIODICITY_100_MILLISECONDS", + "RELAY_CAD_PERIODICITY_50_MILLISECONDS", + "RELAY_CAD_PERIODICITY_20_MILLISECONDS" ] }, - "reload_rate": { - "description": "The number of tokens which are replenished in the bucket every hour.", + "default_channel_index": { + "description": "Index of the default wake on radio channel.\nIf unset, the default value from Network Server configuration will be used.", "type": "integer", "format": "int64" - } - } - }, - "overall": { - "type": "object", - "properties": { - "bucket_size": { - "type": "string", - "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", - "default": "RELAY_LIMIT_BUCKET_SIZE_1", + }, + "limits": { + "type": "object", + "properties": { + "join_requests": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "notifications": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "overall": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "reset_behavior": { + "type": "string", + "default": "RELAY_RESET_LIMIT_COUNTER_ZERO", + "enum": [ + "RELAY_RESET_LIMIT_COUNTER_ZERO", + "RELAY_RESET_LIMIT_COUNTER_RELOAD_RATE", + "RELAY_RESET_LIMIT_COUNTER_MAX_VALUE", + "RELAY_RESET_LIMIT_COUNTER_NO_RESET" + ] + }, + "uplink_messages": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + } + } + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "uplink_forwarding_rules": { + "description": "Configured uplink forwarding rules.", + "type": "array", + "items": { + "type": "object", + "properties": { + "device_id": { + "description": "End device identifier of the served end device.", + "type": "string" + }, + "last_w_f_cnt": { + "description": "Last wake on radio frame counter used by the served end device.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "session_key_id": { + "description": "Session key ID of the session keys used to derive the root relay session key.", + "type": "string", + "format": "byte" + } + } + } + } + } + } + } + }, + "resets_f_cnt": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "rx1_data_rate_offset": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_OFFSET_0", + "enum": [ + "DATA_RATE_OFFSET_0", + "DATA_RATE_OFFSET_1", + "DATA_RATE_OFFSET_2", + "DATA_RATE_OFFSET_3", + "DATA_RATE_OFFSET_4", + "DATA_RATE_OFFSET_5", + "DATA_RATE_OFFSET_6", + "DATA_RATE_OFFSET_7" + ] + } + } + }, + "rx1_delay": { + "type": "object", + "properties": { + "value": { + "description": " - RX_DELAY_0: 1 second.\n - RX_DELAY_1: 1 second.\n - RX_DELAY_2: 2 seconds.\n - RX_DELAY_3: 3 seconds.\n - RX_DELAY_4: 4 seconds.\n - RX_DELAY_5: 5 seconds.\n - RX_DELAY_6: 6 seconds.\n - RX_DELAY_7: 7 seconds.\n - RX_DELAY_8: 8 seconds.\n - RX_DELAY_9: 9 seconds.\n - RX_DELAY_10: 10 seconds.\n - RX_DELAY_11: 11 seconds.\n - RX_DELAY_12: 12 seconds.\n - RX_DELAY_13: 13 seconds.\n - RX_DELAY_14: 14 seconds.\n - RX_DELAY_15: 15 seconds.", + "type": "string", + "default": "RX_DELAY_0", + "enum": [ + "RX_DELAY_0", + "RX_DELAY_1", + "RX_DELAY_2", + "RX_DELAY_3", + "RX_DELAY_4", + "RX_DELAY_5", + "RX_DELAY_6", + "RX_DELAY_7", + "RX_DELAY_8", + "RX_DELAY_9", + "RX_DELAY_10", + "RX_DELAY_11", + "RX_DELAY_12", + "RX_DELAY_13", + "RX_DELAY_14", + "RX_DELAY_15" + ] + } + } + }, + "rx2_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "rx2_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "schedule_downlinks": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "status_count_periodicity": { + "description": "Number of uplink messages after which a DevStatusReq MACCommand shall be sent.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "status_time_periodicity": { + "description": "The interval after which a DevStatusReq MACCommand shall be sent.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "supports_32_bit_f_cnt": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "uplink_dwell_time": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "use_adr": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + } + } + } + } + } + } + } + } + ], + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "type": "object", + "properties": { + "mac_settings_profile": { + "type": "object", + "properties": { + "ids": { + "type": "object", + "properties": { + "application_ids": { + "type": "object", + "properties": { + "application_id": { + "type": "string" + } + } + }, + "profile_id": { + "description": "Profile ID.", + "type": "string" + } + } + }, + "mac_settings": { + "type": "object", + "properties": { + "adr": { + "description": "Adaptive Data Rate settings.", + "type": "object", + "properties": { + "disabled": { + "description": "Configuration options for cases in which ADR is to be disabled\ncompletely.", + "type": "object" + }, + "dynamic": { + "description": "Configuration options for dynamic ADR.", + "type": "object", + "properties": { + "channel_steering": { + "description": "EXPERIMENTAL: Channel steering settings.", + "type": "object", + "properties": { + "disabled": { + "description": "Configuration options for cases in which ADR is not supposed to steer the end device\nto another set of channels.", + "type": "object" + }, + "lora_narrow": { + "description": "Configuration options for LoRa narrow channels steering.\nThe narrow mode attempts to steer the end device towards\nusing the LoRa modulated, 125kHz bandwidth channels.", + "type": "object" + } + } + }, + "margin": { + "description": "The ADR margin (dB) tells the network server how much margin it should add in ADR requests.\nA bigger margin is less efficient, but gives a better chance of successful reception.\nIf unset, the default value from Network Server configuration will be used.", + "type": "number", + "format": "float" + }, + "max_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "max_tx_power_index": { + "description": "Maximum transmission power index.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_tx_power_index": { + "description": "Minimum transmission power index.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "overrides": { + "description": "EXPERIMENTAL: Configuration overrides.", + "type": "object", + "properties": { + "data_rate_0": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_1": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_10": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_11": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_12": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_13": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_14": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_15": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_2": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_3": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_4": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_5": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_6": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_7": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_8": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_9": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + } + } + } + } + }, + "static": { + "description": "Configuration options for static ADR.", + "type": "object", + "properties": { + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", "enum": [ - "RELAY_LIMIT_BUCKET_SIZE_1", - "RELAY_LIMIT_BUCKET_SIZE_2", - "RELAY_LIMIT_BUCKET_SIZE_4", - "RELAY_LIMIT_BUCKET_SIZE_12" + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" ] }, - "reload_rate": { - "description": "The number of tokens which are replenished in the bucket every hour.", + "nb_trans": { + "description": "Number of retransmissions.", + "type": "integer", + "format": "int64" + }, + "tx_power_index": { + "description": "Transmission power index to use.", "type": "integer", "format": "int64" } } - }, - "reset_behavior": { + } + } + }, + "adr_margin": { + "description": "The ADR margin (dB) tells the network server how much margin it should add in ADR requests.\nA bigger margin is less efficient, but gives a better chance of successful reception.\nThis field is deprecated, use adr_settings.dynamic.margin instead.", + "type": "number", + "format": "float" + }, + "beacon_frequency": { + "type": "object", + "properties": { + "value": { "type": "string", - "default": "RELAY_RESET_LIMIT_COUNTER_ZERO", + "format": "uint64" + } + } + }, + "class_b_c_downlink_interval": { + "description": "The minimum duration passed before a network-initiated(e.g. Class B or C) downlink following an arbitrary downlink.", + "type": "string" + }, + "class_b_timeout": { + "description": "Maximum delay for the device to answer a MAC request or a confirmed downlink frame.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "class_c_timeout": { + "description": "Maximum delay for the device to answer a MAC request or a confirmed downlink frame.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "desired_adr_ack_delay_exponent": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "ADR_ACK_DELAY_1", "enum": [ - "RELAY_RESET_LIMIT_COUNTER_ZERO", - "RELAY_RESET_LIMIT_COUNTER_RELOAD_RATE", - "RELAY_RESET_LIMIT_COUNTER_MAX_VALUE", - "RELAY_RESET_LIMIT_COUNTER_NO_RESET" + "ADR_ACK_DELAY_1", + "ADR_ACK_DELAY_2", + "ADR_ACK_DELAY_4", + "ADR_ACK_DELAY_8", + "ADR_ACK_DELAY_16", + "ADR_ACK_DELAY_32", + "ADR_ACK_DELAY_64", + "ADR_ACK_DELAY_128", + "ADR_ACK_DELAY_256", + "ADR_ACK_DELAY_512", + "ADR_ACK_DELAY_1024", + "ADR_ACK_DELAY_2048", + "ADR_ACK_DELAY_4096", + "ADR_ACK_DELAY_8192", + "ADR_ACK_DELAY_16384", + "ADR_ACK_DELAY_32768" + ] + } + } + }, + "desired_adr_ack_limit_exponent": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "ADR_ACK_LIMIT_1", + "enum": [ + "ADR_ACK_LIMIT_1", + "ADR_ACK_LIMIT_2", + "ADR_ACK_LIMIT_4", + "ADR_ACK_LIMIT_8", + "ADR_ACK_LIMIT_16", + "ADR_ACK_LIMIT_32", + "ADR_ACK_LIMIT_64", + "ADR_ACK_LIMIT_128", + "ADR_ACK_LIMIT_256", + "ADR_ACK_LIMIT_512", + "ADR_ACK_LIMIT_1024", + "ADR_ACK_LIMIT_2048", + "ADR_ACK_LIMIT_4096", + "ADR_ACK_LIMIT_8192", + "ADR_ACK_LIMIT_16384", + "ADR_ACK_LIMIT_32768" + ] + } + } + }, + "desired_beacon_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "desired_max_duty_cycle": { + "type": "object", + "properties": { + "value": { + "description": " - DUTY_CYCLE_1: 100%.\n - DUTY_CYCLE_2: 50%.\n - DUTY_CYCLE_4: 25%.\n - DUTY_CYCLE_8: 12.5%.\n - DUTY_CYCLE_16: 6.25%.\n - DUTY_CYCLE_32: 3.125%.\n - DUTY_CYCLE_64: 1.5625%.\n - DUTY_CYCLE_128: Roughly 0.781%.\n - DUTY_CYCLE_256: Roughly 0.390%.\n - DUTY_CYCLE_512: Roughly 0.195%.\n - DUTY_CYCLE_1024: Roughly 0.098%.\n - DUTY_CYCLE_2048: Roughly 0.049%.\n - DUTY_CYCLE_4096: Roughly 0.024%.\n - DUTY_CYCLE_8192: Roughly 0.012%.\n - DUTY_CYCLE_16384: Roughly 0.006%.\n - DUTY_CYCLE_32768: Roughly 0.003%.", + "type": "string", + "default": "DUTY_CYCLE_1", + "enum": [ + "DUTY_CYCLE_1", + "DUTY_CYCLE_2", + "DUTY_CYCLE_4", + "DUTY_CYCLE_8", + "DUTY_CYCLE_16", + "DUTY_CYCLE_32", + "DUTY_CYCLE_64", + "DUTY_CYCLE_128", + "DUTY_CYCLE_256", + "DUTY_CYCLE_512", + "DUTY_CYCLE_1024", + "DUTY_CYCLE_2048", + "DUTY_CYCLE_4096", + "DUTY_CYCLE_8192", + "DUTY_CYCLE_16384", + "DUTY_CYCLE_32768" + ] + } + } + }, + "desired_max_eirp": { + "type": "object", + "properties": { + "value": { + "description": " - DEVICE_EIRP_8: 8 dBm.\n - DEVICE_EIRP_10: 10 dBm.\n - DEVICE_EIRP_12: 12 dBm.\n - DEVICE_EIRP_13: 13 dBm.\n - DEVICE_EIRP_14: 14 dBm.\n - DEVICE_EIRP_16: 16 dBm.\n - DEVICE_EIRP_18: 18 dBm.\n - DEVICE_EIRP_20: 20 dBm.\n - DEVICE_EIRP_21: 21 dBm.\n - DEVICE_EIRP_24: 24 dBm.\n - DEVICE_EIRP_26: 26 dBm.\n - DEVICE_EIRP_27: 27 dBm.\n - DEVICE_EIRP_29: 29 dBm.\n - DEVICE_EIRP_30: 30 dBm.\n - DEVICE_EIRP_33: 33 dBm.\n - DEVICE_EIRP_36: 36 dBm.", + "type": "string", + "default": "DEVICE_EIRP_8", + "enum": [ + "DEVICE_EIRP_8", + "DEVICE_EIRP_10", + "DEVICE_EIRP_12", + "DEVICE_EIRP_13", + "DEVICE_EIRP_14", + "DEVICE_EIRP_16", + "DEVICE_EIRP_18", + "DEVICE_EIRP_20", + "DEVICE_EIRP_21", + "DEVICE_EIRP_24", + "DEVICE_EIRP_26", + "DEVICE_EIRP_27", + "DEVICE_EIRP_29", + "DEVICE_EIRP_30", + "DEVICE_EIRP_33", + "DEVICE_EIRP_36" + ] + } + } + }, + "desired_ping_slot_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" ] + } + } + }, + "desired_ping_slot_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "desired_relay": { + "description": "RelaySettings represent the settings of a relay.\nThis is used internally by the Network Server.", + "type": "object", + "properties": { + "served": { + "type": "object", + "properties": { + "always": { + "type": "object" + }, + "backoff": { + "description": "Number of wake on radio frames to be sent without an acknowledgement before sending the uplink message directly.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "dynamic": { + "type": "object", + "properties": { + "smart_enable_level": { + "type": "string", + "default": "RELAY_SMART_ENABLE_LEVEL_8", + "enum": [ + "RELAY_SMART_ENABLE_LEVEL_8", + "RELAY_SMART_ENABLE_LEVEL_16", + "RELAY_SMART_ENABLE_LEVEL_32", + "RELAY_SMART_ENABLE_LEVEL_64" + ] + } + } + }, + "end_device_controlled": { + "type": "object" + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "serving_device_id": { + "description": "End device identifier of the serving end device.", + "type": "string" + } + } }, - "uplink_messages": { + "serving": { "type": "object", "properties": { - "bucket_size": { + "cad_periodicity": { "type": "string", - "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", - "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "title": "- RELAY_CAD_PERIODICITY_20_MILLISECONDS: sic", + "default": "RELAY_CAD_PERIODICITY_1_SECOND", "enum": [ - "RELAY_LIMIT_BUCKET_SIZE_1", - "RELAY_LIMIT_BUCKET_SIZE_2", - "RELAY_LIMIT_BUCKET_SIZE_4", - "RELAY_LIMIT_BUCKET_SIZE_12" + "RELAY_CAD_PERIODICITY_1_SECOND", + "RELAY_CAD_PERIODICITY_500_MILLISECONDS", + "RELAY_CAD_PERIODICITY_250_MILLISECONDS", + "RELAY_CAD_PERIODICITY_100_MILLISECONDS", + "RELAY_CAD_PERIODICITY_50_MILLISECONDS", + "RELAY_CAD_PERIODICITY_20_MILLISECONDS" ] }, - "reload_rate": { - "description": "The number of tokens which are replenished in the bucket every hour.", + "default_channel_index": { + "description": "Index of the default wake on radio channel.\nIf unset, the default value from Network Server configuration will be used.", "type": "integer", "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "join_requests": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "notifications": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "overall": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "reset_behavior": { + "type": "string", + "default": "RELAY_RESET_LIMIT_COUNTER_ZERO", + "enum": [ + "RELAY_RESET_LIMIT_COUNTER_ZERO", + "RELAY_RESET_LIMIT_COUNTER_RELOAD_RATE", + "RELAY_RESET_LIMIT_COUNTER_MAX_VALUE", + "RELAY_RESET_LIMIT_COUNTER_NO_RESET" + ] + }, + "uplink_messages": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + } + } + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "uplink_forwarding_rules": { + "description": "Configured uplink forwarding rules.", + "type": "array", + "items": { + "type": "object", + "properties": { + "device_id": { + "description": "End device identifier of the served end device.", + "type": "string" + }, + "last_w_f_cnt": { + "description": "Last wake on radio frame counter used by the served end device.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "session_key_id": { + "description": "Session key ID of the session keys used to derive the root relay session key.", + "type": "string", + "format": "byte" + } + } + } } } } } }, - "second_channel": { + "desired_rx1_data_rate_offset": { "type": "object", "properties": { - "ack_offset": { + "value": { "type": "string", - "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", - "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "default": "DATA_RATE_OFFSET_0", "enum": [ - "RELAY_SECOND_CH_ACK_OFFSET_0", - "RELAY_SECOND_CH_ACK_OFFSET_200", - "RELAY_SECOND_CH_ACK_OFFSET_400", - "RELAY_SECOND_CH_ACK_OFFSET_800", - "RELAY_SECOND_CH_ACK_OFFSET_1600", - "RELAY_SECOND_CH_ACK_OFFSET_3200" + "DATA_RATE_OFFSET_0", + "DATA_RATE_OFFSET_1", + "DATA_RATE_OFFSET_2", + "DATA_RATE_OFFSET_3", + "DATA_RATE_OFFSET_4", + "DATA_RATE_OFFSET_5", + "DATA_RATE_OFFSET_6", + "DATA_RATE_OFFSET_7" ] - }, - "data_rate_index": { + } + } + }, + "desired_rx1_delay": { + "type": "object", + "properties": { + "value": { + "description": " - RX_DELAY_0: 1 second.\n - RX_DELAY_1: 1 second.\n - RX_DELAY_2: 2 seconds.\n - RX_DELAY_3: 3 seconds.\n - RX_DELAY_4: 4 seconds.\n - RX_DELAY_5: 5 seconds.\n - RX_DELAY_6: 6 seconds.\n - RX_DELAY_7: 7 seconds.\n - RX_DELAY_8: 8 seconds.\n - RX_DELAY_9: 9 seconds.\n - RX_DELAY_10: 10 seconds.\n - RX_DELAY_11: 11 seconds.\n - RX_DELAY_12: 12 seconds.\n - RX_DELAY_13: 13 seconds.\n - RX_DELAY_14: 14 seconds.\n - RX_DELAY_15: 15 seconds.", + "type": "string", + "default": "RX_DELAY_0", + "enum": [ + "RX_DELAY_0", + "RX_DELAY_1", + "RX_DELAY_2", + "RX_DELAY_3", + "RX_DELAY_4", + "RX_DELAY_5", + "RX_DELAY_6", + "RX_DELAY_7", + "RX_DELAY_8", + "RX_DELAY_9", + "RX_DELAY_10", + "RX_DELAY_11", + "RX_DELAY_12", + "RX_DELAY_13", + "RX_DELAY_14", + "RX_DELAY_15" + ] + } + } + }, + "desired_rx2_data_rate_index": { + "type": "object", + "properties": { + "value": { "type": "string", "default": "DATA_RATE_0", "enum": [ @@ -419789,193 +423738,550 @@ "DATA_RATE_14", "DATA_RATE_15" ] - }, - "frequency": { - "description": "The frequency (Hz) used by the wake on radio message.", + } + } + }, + "desired_rx2_frequency": { + "type": "object", + "properties": { + "value": { "type": "string", "format": "uint64" } } }, - "uplink_forwarding_rules": { - "description": "Configured uplink forwarding rules.", + "downlink_dwell_time": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "factory_preset_frequencies": { + "description": "List of factory-preset frequencies.\nIf unset, the default value from Network Server configuration or regional parameters specification will be used.", "type": "array", "items": { - "type": "object", - "properties": { - "device_id": { - "description": "End device identifier of the served end device.", - "type": "string" - }, - "last_w_f_cnt": { - "description": "Last wake on radio frame counter used by the served end device.", - "type": "integer", - "format": "int64" - }, - "limits": { - "type": "object", - "properties": { - "bucket_size": { - "type": "string", - "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", - "default": "RELAY_LIMIT_BUCKET_SIZE_1", - "enum": [ - "RELAY_LIMIT_BUCKET_SIZE_1", - "RELAY_LIMIT_BUCKET_SIZE_2", - "RELAY_LIMIT_BUCKET_SIZE_4", - "RELAY_LIMIT_BUCKET_SIZE_12" - ] - }, - "reload_rate": { - "description": "The number of tokens which are replenished in the bucket every hour.", - "type": "integer", - "format": "int64" + "type": "string", + "format": "uint64" + } + }, + "max_duty_cycle": { + "type": "object", + "properties": { + "value": { + "description": " - DUTY_CYCLE_1: 100%.\n - DUTY_CYCLE_2: 50%.\n - DUTY_CYCLE_4: 25%.\n - DUTY_CYCLE_8: 12.5%.\n - DUTY_CYCLE_16: 6.25%.\n - DUTY_CYCLE_32: 3.125%.\n - DUTY_CYCLE_64: 1.5625%.\n - DUTY_CYCLE_128: Roughly 0.781%.\n - DUTY_CYCLE_256: Roughly 0.390%.\n - DUTY_CYCLE_512: Roughly 0.195%.\n - DUTY_CYCLE_1024: Roughly 0.098%.\n - DUTY_CYCLE_2048: Roughly 0.049%.\n - DUTY_CYCLE_4096: Roughly 0.024%.\n - DUTY_CYCLE_8192: Roughly 0.012%.\n - DUTY_CYCLE_16384: Roughly 0.006%.\n - DUTY_CYCLE_32768: Roughly 0.003%.", + "type": "string", + "default": "DUTY_CYCLE_1", + "enum": [ + "DUTY_CYCLE_1", + "DUTY_CYCLE_2", + "DUTY_CYCLE_4", + "DUTY_CYCLE_8", + "DUTY_CYCLE_16", + "DUTY_CYCLE_32", + "DUTY_CYCLE_64", + "DUTY_CYCLE_128", + "DUTY_CYCLE_256", + "DUTY_CYCLE_512", + "DUTY_CYCLE_1024", + "DUTY_CYCLE_2048", + "DUTY_CYCLE_4096", + "DUTY_CYCLE_8192", + "DUTY_CYCLE_16384", + "DUTY_CYCLE_32768" + ] + } + } + }, + "ping_slot_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "ping_slot_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "ping_slot_periodicity": { + "type": "object", + "properties": { + "value": { + "description": " - PING_EVERY_1S: Every second.\n - PING_EVERY_2S: Every 2 seconds.\n - PING_EVERY_4S: Every 4 seconds.\n - PING_EVERY_8S: Every 8 seconds.\n - PING_EVERY_16S: Every 16 seconds.\n - PING_EVERY_32S: Every 32 seconds.\n - PING_EVERY_64S: Every 64 seconds.\n - PING_EVERY_128S: Every 128 seconds.", + "type": "string", + "default": "PING_EVERY_1S", + "enum": [ + "PING_EVERY_1S", + "PING_EVERY_2S", + "PING_EVERY_4S", + "PING_EVERY_8S", + "PING_EVERY_16S", + "PING_EVERY_32S", + "PING_EVERY_64S", + "PING_EVERY_128S" + ] + } + } + }, + "relay": { + "description": "RelaySettings represent the settings of a relay.\nThis is used internally by the Network Server.", + "type": "object", + "properties": { + "served": { + "type": "object", + "properties": { + "always": { + "type": "object" + }, + "backoff": { + "description": "Number of wake on radio frames to be sent without an acknowledgement before sending the uplink message directly.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "dynamic": { + "type": "object", + "properties": { + "smart_enable_level": { + "type": "string", + "default": "RELAY_SMART_ENABLE_LEVEL_8", + "enum": [ + "RELAY_SMART_ENABLE_LEVEL_8", + "RELAY_SMART_ENABLE_LEVEL_16", + "RELAY_SMART_ENABLE_LEVEL_32", + "RELAY_SMART_ENABLE_LEVEL_64" + ] + } + } + }, + "end_device_controlled": { + "type": "object" + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "serving_device_id": { + "description": "End device identifier of the serving end device.", + "type": "string" + } + } + }, + "serving": { + "type": "object", + "properties": { + "cad_periodicity": { + "type": "string", + "title": "- RELAY_CAD_PERIODICITY_20_MILLISECONDS: sic", + "default": "RELAY_CAD_PERIODICITY_1_SECOND", + "enum": [ + "RELAY_CAD_PERIODICITY_1_SECOND", + "RELAY_CAD_PERIODICITY_500_MILLISECONDS", + "RELAY_CAD_PERIODICITY_250_MILLISECONDS", + "RELAY_CAD_PERIODICITY_100_MILLISECONDS", + "RELAY_CAD_PERIODICITY_50_MILLISECONDS", + "RELAY_CAD_PERIODICITY_20_MILLISECONDS" + ] + }, + "default_channel_index": { + "description": "Index of the default wake on radio channel.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "join_requests": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "notifications": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "overall": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "reset_behavior": { + "type": "string", + "default": "RELAY_RESET_LIMIT_COUNTER_ZERO", + "enum": [ + "RELAY_RESET_LIMIT_COUNTER_ZERO", + "RELAY_RESET_LIMIT_COUNTER_RELOAD_RATE", + "RELAY_RESET_LIMIT_COUNTER_MAX_VALUE", + "RELAY_RESET_LIMIT_COUNTER_NO_RESET" + ] + }, + "uplink_messages": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + } + } + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "uplink_forwarding_rules": { + "description": "Configured uplink forwarding rules.", + "type": "array", + "items": { + "type": "object", + "properties": { + "device_id": { + "description": "End device identifier of the served end device.", + "type": "string" + }, + "last_w_f_cnt": { + "description": "Last wake on radio frame counter used by the served end device.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "session_key_id": { + "description": "Session key ID of the session keys used to derive the root relay session key.", + "type": "string", + "format": "byte" + } + } } } - }, - "session_key_id": { - "description": "Session key ID of the session keys used to derive the root relay session key.", - "type": "string", - "format": "byte" } } } + }, + "resets_f_cnt": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "rx1_data_rate_offset": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_OFFSET_0", + "enum": [ + "DATA_RATE_OFFSET_0", + "DATA_RATE_OFFSET_1", + "DATA_RATE_OFFSET_2", + "DATA_RATE_OFFSET_3", + "DATA_RATE_OFFSET_4", + "DATA_RATE_OFFSET_5", + "DATA_RATE_OFFSET_6", + "DATA_RATE_OFFSET_7" + ] + } + } + }, + "rx1_delay": { + "type": "object", + "properties": { + "value": { + "description": " - RX_DELAY_0: 1 second.\n - RX_DELAY_1: 1 second.\n - RX_DELAY_2: 2 seconds.\n - RX_DELAY_3: 3 seconds.\n - RX_DELAY_4: 4 seconds.\n - RX_DELAY_5: 5 seconds.\n - RX_DELAY_6: 6 seconds.\n - RX_DELAY_7: 7 seconds.\n - RX_DELAY_8: 8 seconds.\n - RX_DELAY_9: 9 seconds.\n - RX_DELAY_10: 10 seconds.\n - RX_DELAY_11: 11 seconds.\n - RX_DELAY_12: 12 seconds.\n - RX_DELAY_13: 13 seconds.\n - RX_DELAY_14: 14 seconds.\n - RX_DELAY_15: 15 seconds.", + "type": "string", + "default": "RX_DELAY_0", + "enum": [ + "RX_DELAY_0", + "RX_DELAY_1", + "RX_DELAY_2", + "RX_DELAY_3", + "RX_DELAY_4", + "RX_DELAY_5", + "RX_DELAY_6", + "RX_DELAY_7", + "RX_DELAY_8", + "RX_DELAY_9", + "RX_DELAY_10", + "RX_DELAY_11", + "RX_DELAY_12", + "RX_DELAY_13", + "RX_DELAY_14", + "RX_DELAY_15" + ] + } + } + }, + "rx2_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "rx2_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "schedule_downlinks": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "status_count_periodicity": { + "description": "Number of uplink messages after which a DevStatusReq MACCommand shall be sent.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "status_time_periodicity": { + "description": "The interval after which a DevStatusReq MACCommand shall be sent.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "supports_32_bit_f_cnt": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "uplink_dwell_time": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "use_adr": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } } } } } - }, - "resets_f_cnt": { - "type": "object", - "properties": { - "value": { - "type": "boolean" - } - } - }, - "rx1_data_rate_offset": { - "type": "object", - "properties": { - "value": { - "type": "string", - "default": "DATA_RATE_OFFSET_0", - "enum": [ - "DATA_RATE_OFFSET_0", - "DATA_RATE_OFFSET_1", - "DATA_RATE_OFFSET_2", - "DATA_RATE_OFFSET_3", - "DATA_RATE_OFFSET_4", - "DATA_RATE_OFFSET_5", - "DATA_RATE_OFFSET_6", - "DATA_RATE_OFFSET_7" - ] - } - } - }, - "rx1_delay": { - "type": "object", - "properties": { - "value": { - "description": " - RX_DELAY_0: 1 second.\n - RX_DELAY_1: 1 second.\n - RX_DELAY_2: 2 seconds.\n - RX_DELAY_3: 3 seconds.\n - RX_DELAY_4: 4 seconds.\n - RX_DELAY_5: 5 seconds.\n - RX_DELAY_6: 6 seconds.\n - RX_DELAY_7: 7 seconds.\n - RX_DELAY_8: 8 seconds.\n - RX_DELAY_9: 9 seconds.\n - RX_DELAY_10: 10 seconds.\n - RX_DELAY_11: 11 seconds.\n - RX_DELAY_12: 12 seconds.\n - RX_DELAY_13: 13 seconds.\n - RX_DELAY_14: 14 seconds.\n - RX_DELAY_15: 15 seconds.", - "type": "string", - "default": "RX_DELAY_0", - "enum": [ - "RX_DELAY_0", - "RX_DELAY_1", - "RX_DELAY_2", - "RX_DELAY_3", - "RX_DELAY_4", - "RX_DELAY_5", - "RX_DELAY_6", - "RX_DELAY_7", - "RX_DELAY_8", - "RX_DELAY_9", - "RX_DELAY_10", - "RX_DELAY_11", - "RX_DELAY_12", - "RX_DELAY_13", - "RX_DELAY_14", - "RX_DELAY_15" - ] - } - } - }, - "rx2_data_rate_index": { - "type": "object", - "properties": { - "value": { - "type": "string", - "default": "DATA_RATE_0", - "enum": [ - "DATA_RATE_0", - "DATA_RATE_1", - "DATA_RATE_2", - "DATA_RATE_3", - "DATA_RATE_4", - "DATA_RATE_5", - "DATA_RATE_6", - "DATA_RATE_7", - "DATA_RATE_8", - "DATA_RATE_9", - "DATA_RATE_10", - "DATA_RATE_11", - "DATA_RATE_12", - "DATA_RATE_13", - "DATA_RATE_14", - "DATA_RATE_15" - ] - } - } - }, - "rx2_frequency": { - "type": "object", - "properties": { - "value": { - "type": "string", - "format": "uint64" - } - } - }, - "schedule_downlinks": { - "type": "object", - "properties": { - "value": { - "type": "boolean" - } - } - }, - "status_count_periodicity": { - "description": "Number of uplink messages after which a DevStatusReq MACCommand shall be sent.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" - }, - "status_time_periodicity": { - "description": "The interval after which a DevStatusReq MACCommand shall be sent.\nIf unset, the default value from Network Server configuration will be used.", - "type": "string" - }, - "supports_32_bit_f_cnt": { - "type": "object", - "properties": { - "value": { - "type": "boolean" - } - } - }, - "uplink_dwell_time": { - "type": "object", - "properties": { - "value": { - "type": "boolean" - } - } - }, - "use_adr": { - "type": "object", - "properties": { - "value": { - "type": "boolean" - } - } } } } @@ -420012,655 +424318,1562 @@ } } }, - "/ns/dev_addr": { + "/ns/applications/{mac_settings_profile_ids.application_ids.application_id}/mac_settings_profiles/{mac_settings_profile_ids.profile_id}": { "get": { "tags": [ - "Ns" + "NsMACSettingsProfileRegistry" + ], + "summary": "Get returns the MAC settings profile that matches the given identifiers.", + "operationId": "NsMACSettingsProfileRegistry_Get", + "parameters": [ + { + "type": "string", + "name": "mac_settings_profile_ids.application_ids.application_id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "Profile ID.", + "name": "mac_settings_profile_ids.profile_id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "The names of the fields that should be returned.", + "name": "field_mask", + "in": "query" + } ], - "summary": "GenerateDevAddr requests a device address assignment from the Network Server.", - "operationId": "Ns_GenerateDevAddr", "responses": { "200": { "description": "A successful response.", - "schema": { - "description": "Response of GenerateDevAddr.", - "type": "object", - "properties": { - "dev_addr": { - "type": "string", - "format": "string", - "example": "2600ABCD" - } - } - } - }, - "default": { - "description": "An unexpected error response.", "schema": { "type": "object", "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "details": { - "type": "array", - "items": { - "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }", - "type": "object", - "properties": { - "@type": { - "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.", - "type": "string" - } - }, - "additionalProperties": {} - } - }, - "message": { - "type": "string" - } - } - } - } - } - } - }, - "/ns/dev_addr_prefixes": { - "get": { - "tags": [ - "Ns" - ], - "operationId": "Ns_GetDeviceAddressPrefixes", - "responses": { - "200": { - "description": "A successful response.", - "schema": { - "type": "object", - "properties": { - "dev_addr_prefixes": { - "type": "array", - "items": { - "type": "string", - "format": "byte" - }, - "example": [ - "2600AB00/24" - ] - } - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "details": { - "type": "array", - "items": { - "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }", - "type": "object", - "properties": { - "@type": { - "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.", - "type": "string" - } - }, - "additionalProperties": {} - } - }, - "message": { - "type": "string" - } - } - } - } - } - } - }, - "/ns/net_id": { - "get": { - "tags": [ - "Ns" - ], - "operationId": "Ns_GetNetID", - "responses": { - "200": { - "description": "A successful response.", - "schema": { - "type": "object", - "properties": { - "net_id": { - "type": "string", - "format": "string", - "example": "000013" - } - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "details": { - "type": "array", - "items": { - "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }", - "type": "object", - "properties": { - "@type": { - "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.", - "type": "string" + "mac_settings_profile": { + "type": "object", + "properties": { + "ids": { + "type": "object", + "properties": { + "application_ids": { + "type": "object", + "properties": { + "application_id": { + "type": "string" + } + } + }, + "profile_id": { + "description": "Profile ID.", + "type": "string" + } } }, - "additionalProperties": {} - } - }, - "message": { - "type": "string" - } - } - } - } - } - } - }, - "/organizations": { - "get": { - "description": "If no user or organization is given, this returns the organizations the caller\nhas access to.\nSimilar to Get, this selects the fields given by the field mask.\nMore or less fields may be returned, depending on the rights of the caller.", - "tags": [ - "OrganizationRegistry" - ], - "summary": "List organizations where the given user or organization is a direct collaborator.", - "operationId": "OrganizationRegistry_List", - "parameters": [ - { - "type": "string", - "description": "This ID shares namespace with user IDs.", - "name": "collaborator.organization_ids.organization_id", - "in": "query" - }, - { - "type": "string", - "description": "This ID shares namespace with organization IDs.", - "name": "collaborator.user_ids.user_id", - "in": "query" - }, - { - "type": "string", - "description": "Secondary identifier, which can only be used in specific requests.", - "name": "collaborator.user_ids.email", - "in": "query" - }, - { - "type": "string", - "description": "The names of the organization fields that should be returned.", - "name": "field_mask", - "in": "query" - }, - { - "type": "string", - "description": "Order the results by this field path (must be present in the field mask).\nDefault ordering is by ID. Prepend with a minus (-) to reverse the order.", - "name": "order", - "in": "query" - }, - { - "type": "integer", - "format": "int64", - "description": "Limit the number of results per page.", - "name": "limit", - "in": "query" - }, - { - "type": "integer", - "format": "int64", - "description": "Page number for pagination. 0 is interpreted as 1.", - "name": "page", - "in": "query" - }, - { - "type": "boolean", - "description": "Only return recently deleted organizations.", - "name": "deleted", - "in": "query" - } - ], - "responses": { - "200": { - "description": "A successful response.", - "schema": { - "type": "object", - "properties": { - "organizations": { - "type": "array", - "items": { - "type": "object", - "properties": { - "administrative_contact": { - "description": "OrganizationOrUserIdentifiers contains either organization or user identifiers.", - "type": "object", - "properties": { - "organization_ids": { - "type": "object", - "properties": { - "organization_id": { - "description": "This ID shares namespace with user IDs.", - "type": "string" + "mac_settings": { + "type": "object", + "properties": { + "adr": { + "description": "Adaptive Data Rate settings.", + "type": "object", + "properties": { + "disabled": { + "description": "Configuration options for cases in which ADR is to be disabled\ncompletely.", + "type": "object" + }, + "dynamic": { + "description": "Configuration options for dynamic ADR.", + "type": "object", + "properties": { + "channel_steering": { + "description": "EXPERIMENTAL: Channel steering settings.", + "type": "object", + "properties": { + "disabled": { + "description": "Configuration options for cases in which ADR is not supposed to steer the end device\nto another set of channels.", + "type": "object" + }, + "lora_narrow": { + "description": "Configuration options for LoRa narrow channels steering.\nThe narrow mode attempts to steer the end device towards\nusing the LoRa modulated, 125kHz bandwidth channels.", + "type": "object" + } + } + }, + "margin": { + "description": "The ADR margin (dB) tells the network server how much margin it should add in ADR requests.\nA bigger margin is less efficient, but gives a better chance of successful reception.\nIf unset, the default value from Network Server configuration will be used.", + "type": "number", + "format": "float" + }, + "max_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "max_tx_power_index": { + "description": "Maximum transmission power index.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_tx_power_index": { + "description": "Minimum transmission power index.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "overrides": { + "description": "EXPERIMENTAL: Configuration overrides.", + "type": "object", + "properties": { + "data_rate_0": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_1": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_10": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_11": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_12": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_13": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_14": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_15": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_2": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_3": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_4": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_5": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_6": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_7": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_8": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_9": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + } + } + } } - } - }, - "user_ids": { - "type": "object", - "properties": { - "email": { - "description": "Secondary identifier, which can only be used in specific requests.", - "type": "string" - }, - "user_id": { - "description": "This ID shares namespace with organization IDs.", - "type": "string" + }, + "static": { + "description": "Configuration options for static ADR.", + "type": "object", + "properties": { + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "nb_trans": { + "description": "Number of retransmissions.", + "type": "integer", + "format": "int64" + }, + "tx_power_index": { + "description": "Transmission power index to use.", + "type": "integer", + "format": "int64" + } } } } - } - }, - "application_limit": { - "description": "The maximum number of applications of the organization.\nThis field can only be modified by admins.", - "type": "string", - "format": "uint64" - }, - "attributes": { - "description": "Key-value attributes for this organization. Typically used for organizing organizations or for storing integration-specific data.", - "type": "object", - "additionalProperties": { + }, + "adr_margin": { + "description": "The ADR margin (dB) tells the network server how much margin it should add in ADR requests.\nA bigger margin is less efficient, but gives a better chance of successful reception.\nThis field is deprecated, use adr_settings.dynamic.margin instead.", + "type": "number", + "format": "float" + }, + "beacon_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "class_b_c_downlink_interval": { + "description": "The minimum duration passed before a network-initiated(e.g. Class B or C) downlink following an arbitrary downlink.", "type": "string" - } - }, - "client_limit": { - "description": "The maximum number of clients of the organization.\nThis field can only be modified by admins.", - "type": "string", - "format": "uint64" - }, - "contact_info": { - "description": "Contact information for this organization. Typically used to indicate who to contact with security/billing questions about the organization.\nThis field is deprecated. Use administrative_contact and technical_contact instead.", - "type": "array", - "items": { + }, + "class_b_timeout": { + "description": "Maximum delay for the device to answer a MAC request or a confirmed downlink frame.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "class_c_timeout": { + "description": "Maximum delay for the device to answer a MAC request or a confirmed downlink frame.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "desired_adr_ack_delay_exponent": { "type": "object", "properties": { - "contact_method": { + "value": { "type": "string", - "default": "CONTACT_METHOD_OTHER", + "default": "ADR_ACK_DELAY_1", "enum": [ - "CONTACT_METHOD_OTHER", - "CONTACT_METHOD_EMAIL", - "CONTACT_METHOD_PHONE" + "ADR_ACK_DELAY_1", + "ADR_ACK_DELAY_2", + "ADR_ACK_DELAY_4", + "ADR_ACK_DELAY_8", + "ADR_ACK_DELAY_16", + "ADR_ACK_DELAY_32", + "ADR_ACK_DELAY_64", + "ADR_ACK_DELAY_128", + "ADR_ACK_DELAY_256", + "ADR_ACK_DELAY_512", + "ADR_ACK_DELAY_1024", + "ADR_ACK_DELAY_2048", + "ADR_ACK_DELAY_4096", + "ADR_ACK_DELAY_8192", + "ADR_ACK_DELAY_16384", + "ADR_ACK_DELAY_32768" ] - }, - "contact_type": { + } + } + }, + "desired_adr_ack_limit_exponent": { + "type": "object", + "properties": { + "value": { "type": "string", - "default": "CONTACT_TYPE_OTHER", + "default": "ADR_ACK_LIMIT_1", "enum": [ - "CONTACT_TYPE_OTHER", - "CONTACT_TYPE_ABUSE", - "CONTACT_TYPE_BILLING", - "CONTACT_TYPE_TECHNICAL" + "ADR_ACK_LIMIT_1", + "ADR_ACK_LIMIT_2", + "ADR_ACK_LIMIT_4", + "ADR_ACK_LIMIT_8", + "ADR_ACK_LIMIT_16", + "ADR_ACK_LIMIT_32", + "ADR_ACK_LIMIT_64", + "ADR_ACK_LIMIT_128", + "ADR_ACK_LIMIT_256", + "ADR_ACK_LIMIT_512", + "ADR_ACK_LIMIT_1024", + "ADR_ACK_LIMIT_2048", + "ADR_ACK_LIMIT_4096", + "ADR_ACK_LIMIT_8192", + "ADR_ACK_LIMIT_16384", + "ADR_ACK_LIMIT_32768" ] - }, - "public": { - "type": "boolean" - }, - "validated_at": { + } + } + }, + "desired_beacon_frequency": { + "type": "object", + "properties": { + "value": { "type": "string", - "format": "date-time" - }, + "format": "uint64" + } + } + }, + "desired_max_duty_cycle": { + "type": "object", + "properties": { "value": { - "type": "string" + "description": " - DUTY_CYCLE_1: 100%.\n - DUTY_CYCLE_2: 50%.\n - DUTY_CYCLE_4: 25%.\n - DUTY_CYCLE_8: 12.5%.\n - DUTY_CYCLE_16: 6.25%.\n - DUTY_CYCLE_32: 3.125%.\n - DUTY_CYCLE_64: 1.5625%.\n - DUTY_CYCLE_128: Roughly 0.781%.\n - DUTY_CYCLE_256: Roughly 0.390%.\n - DUTY_CYCLE_512: Roughly 0.195%.\n - DUTY_CYCLE_1024: Roughly 0.098%.\n - DUTY_CYCLE_2048: Roughly 0.049%.\n - DUTY_CYCLE_4096: Roughly 0.024%.\n - DUTY_CYCLE_8192: Roughly 0.012%.\n - DUTY_CYCLE_16384: Roughly 0.006%.\n - DUTY_CYCLE_32768: Roughly 0.003%.", + "type": "string", + "default": "DUTY_CYCLE_1", + "enum": [ + "DUTY_CYCLE_1", + "DUTY_CYCLE_2", + "DUTY_CYCLE_4", + "DUTY_CYCLE_8", + "DUTY_CYCLE_16", + "DUTY_CYCLE_32", + "DUTY_CYCLE_64", + "DUTY_CYCLE_128", + "DUTY_CYCLE_256", + "DUTY_CYCLE_512", + "DUTY_CYCLE_1024", + "DUTY_CYCLE_2048", + "DUTY_CYCLE_4096", + "DUTY_CYCLE_8192", + "DUTY_CYCLE_16384", + "DUTY_CYCLE_32768" + ] } } - } - }, - "created_at": { - "description": "When the organization was created. This information is public and can be seen by any authenticated user in the network.", - "type": "string", - "format": "date-time" - }, - "deleted_at": { - "description": "When the organization was deleted. This information is public and can be seen by any authenticated user in the network.", - "type": "string", - "format": "date-time" - }, - "description": { - "description": "A description for the organization.", - "type": "string" - }, - "fanout_notifications": { - "description": "Determines if a notification will be sent to the collaborators. If false it, notifications will be sent only to the\nadministrative or technical contact.", - "type": "boolean" - }, - "gateway_limit": { - "description": "The maximum number of gateways of the organization.\nThis field can only be modified by admins.", - "type": "string", - "format": "uint64" - }, - "ids": { - "type": "object", - "properties": { - "organization_id": { - "description": "This ID shares namespace with user IDs.", - "type": "string" + }, + "desired_max_eirp": { + "type": "object", + "properties": { + "value": { + "description": " - DEVICE_EIRP_8: 8 dBm.\n - DEVICE_EIRP_10: 10 dBm.\n - DEVICE_EIRP_12: 12 dBm.\n - DEVICE_EIRP_13: 13 dBm.\n - DEVICE_EIRP_14: 14 dBm.\n - DEVICE_EIRP_16: 16 dBm.\n - DEVICE_EIRP_18: 18 dBm.\n - DEVICE_EIRP_20: 20 dBm.\n - DEVICE_EIRP_21: 21 dBm.\n - DEVICE_EIRP_24: 24 dBm.\n - DEVICE_EIRP_26: 26 dBm.\n - DEVICE_EIRP_27: 27 dBm.\n - DEVICE_EIRP_29: 29 dBm.\n - DEVICE_EIRP_30: 30 dBm.\n - DEVICE_EIRP_33: 33 dBm.\n - DEVICE_EIRP_36: 36 dBm.", + "type": "string", + "default": "DEVICE_EIRP_8", + "enum": [ + "DEVICE_EIRP_8", + "DEVICE_EIRP_10", + "DEVICE_EIRP_12", + "DEVICE_EIRP_13", + "DEVICE_EIRP_14", + "DEVICE_EIRP_16", + "DEVICE_EIRP_18", + "DEVICE_EIRP_20", + "DEVICE_EIRP_21", + "DEVICE_EIRP_24", + "DEVICE_EIRP_26", + "DEVICE_EIRP_27", + "DEVICE_EIRP_29", + "DEVICE_EIRP_30", + "DEVICE_EIRP_33", + "DEVICE_EIRP_36" + ] + } } - } - }, - "name": { - "description": "The name of the organization. This information is public and can be seen by any authenticated user in the network.", - "type": "string" - }, - "technical_contact": { - "description": "OrganizationOrUserIdentifiers contains either organization or user identifiers.", - "type": "object", - "properties": { - "organization_ids": { - "type": "object", - "properties": { - "organization_id": { - "description": "This ID shares namespace with user IDs.", - "type": "string" - } + }, + "desired_ping_slot_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] } - }, - "user_ids": { - "type": "object", - "properties": { - "email": { - "description": "Secondary identifier, which can only be used in specific requests.", - "type": "string" - }, - "user_id": { - "description": "This ID shares namespace with organization IDs.", - "type": "string" - } + } + }, + "desired_ping_slot_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" } } - } - }, - "updated_at": { - "description": "When the organization was last updated. This information is public and can be seen by any authenticated user in the network.", - "type": "string", - "format": "date-time" - } - } - } - } - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "details": { - "type": "array", - "items": { - "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }", - "type": "object", - "properties": { - "@type": { - "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.", - "type": "string" - } - }, - "additionalProperties": {} - } - }, - "message": { - "type": "string" - } - } - } - } - } - } - }, - "/organizations/{collaborator.organization_ids.organization_id}/applications": { - "get": { - "description": "If no user or organization is given, this returns the applications the caller\nhas access to.\nSimilar to Get, this selects the fields given by the field mask.\nMore or less fields may be returned, depending on the rights of the caller.", - "tags": [ - "ApplicationRegistry" - ], - "summary": "List applications where the given user or organization is a direct collaborator.", - "operationId": "ApplicationRegistry_List3", - "parameters": [ - { - "type": "string", - "description": "This ID shares namespace with user IDs.", - "name": "collaborator.organization_ids.organization_id", - "in": "path", - "required": true - }, - { - "type": "string", - "description": "This ID shares namespace with organization IDs.", - "name": "collaborator.user_ids.user_id", - "in": "query" - }, - { - "type": "string", - "description": "Secondary identifier, which can only be used in specific requests.", - "name": "collaborator.user_ids.email", - "in": "query" - }, - { - "type": "string", - "description": "The names of the application fields that should be returned.", - "name": "field_mask", - "in": "query" - }, - { - "type": "string", - "description": "Order the results by this field path (must be present in the field mask).\nDefault ordering is by ID. Prepend with a minus (-) to reverse the order.", - "name": "order", - "in": "query" - }, - { - "type": "integer", - "format": "int64", - "description": "Limit the number of results per page.", - "name": "limit", - "in": "query" - }, - { - "type": "integer", - "format": "int64", - "description": "Page number for pagination. 0 is interpreted as 1.", - "name": "page", - "in": "query" - }, - { - "type": "boolean", - "description": "Only return recently deleted applications.", - "name": "deleted", - "in": "query" - } - ], - "responses": { - "200": { - "description": "A successful response.", - "schema": { - "type": "object", - "properties": { - "applications": { - "type": "array", - "items": { - "description": "Application is the message that defines an Application in the network.", - "type": "object", - "properties": { - "administrative_contact": { - "description": "OrganizationOrUserIdentifiers contains either organization or user identifiers.", - "type": "object", - "properties": { - "organization_ids": { - "type": "object", - "properties": { - "organization_id": { - "description": "This ID shares namespace with user IDs.", - "type": "string" + }, + "desired_relay": { + "description": "RelaySettings represent the settings of a relay.\nThis is used internally by the Network Server.", + "type": "object", + "properties": { + "served": { + "type": "object", + "properties": { + "always": { + "type": "object" + }, + "backoff": { + "description": "Number of wake on radio frames to be sent without an acknowledgement before sending the uplink message directly.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "dynamic": { + "type": "object", + "properties": { + "smart_enable_level": { + "type": "string", + "default": "RELAY_SMART_ENABLE_LEVEL_8", + "enum": [ + "RELAY_SMART_ENABLE_LEVEL_8", + "RELAY_SMART_ENABLE_LEVEL_16", + "RELAY_SMART_ENABLE_LEVEL_32", + "RELAY_SMART_ENABLE_LEVEL_64" + ] + } + } + }, + "end_device_controlled": { + "type": "object" + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "serving_device_id": { + "description": "End device identifier of the serving end device.", + "type": "string" + } } - } - }, - "user_ids": { - "type": "object", - "properties": { - "email": { - "description": "Secondary identifier, which can only be used in specific requests.", - "type": "string" - }, - "user_id": { - "description": "This ID shares namespace with organization IDs.", - "type": "string" + }, + "serving": { + "type": "object", + "properties": { + "cad_periodicity": { + "type": "string", + "title": "- RELAY_CAD_PERIODICITY_20_MILLISECONDS: sic", + "default": "RELAY_CAD_PERIODICITY_1_SECOND", + "enum": [ + "RELAY_CAD_PERIODICITY_1_SECOND", + "RELAY_CAD_PERIODICITY_500_MILLISECONDS", + "RELAY_CAD_PERIODICITY_250_MILLISECONDS", + "RELAY_CAD_PERIODICITY_100_MILLISECONDS", + "RELAY_CAD_PERIODICITY_50_MILLISECONDS", + "RELAY_CAD_PERIODICITY_20_MILLISECONDS" + ] + }, + "default_channel_index": { + "description": "Index of the default wake on radio channel.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "join_requests": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "notifications": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "overall": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "reset_behavior": { + "type": "string", + "default": "RELAY_RESET_LIMIT_COUNTER_ZERO", + "enum": [ + "RELAY_RESET_LIMIT_COUNTER_ZERO", + "RELAY_RESET_LIMIT_COUNTER_RELOAD_RATE", + "RELAY_RESET_LIMIT_COUNTER_MAX_VALUE", + "RELAY_RESET_LIMIT_COUNTER_NO_RESET" + ] + }, + "uplink_messages": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + } + } + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "uplink_forwarding_rules": { + "description": "Configured uplink forwarding rules.", + "type": "array", + "items": { + "type": "object", + "properties": { + "device_id": { + "description": "End device identifier of the served end device.", + "type": "string" + }, + "last_w_f_cnt": { + "description": "Last wake on radio frame counter used by the served end device.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "session_key_id": { + "description": "Session key ID of the session keys used to derive the root relay session key.", + "type": "string", + "format": "byte" + } + } + } + } } } } - } - }, - "application_server_address": { - "description": "The address of the Application Server where this application is supposed to be registered.\nIf set, this fields indicates where end devices for this application should be registered.\n\nStored in Entity Registry.\nThe typical format of the address is \"host:port\". If the port is omitted,\nthe normal port inference (with DNS lookup, otherwise defaults) is used.\nThe connection shall be established with transport layer security (TLS).\nCustom certificate authorities may be configured out-of-band.", - "type": "string" - }, - "attributes": { - "description": "Key-value attributes for this application. Typically used for organizing applications or for storing integration-specific data.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "contact_info": { - "description": "Contact information for this application. Typically used to indicate who to contact with technical/security questions about the application.\nThis field is deprecated. Use administrative_contact and technical_contact instead.", - "type": "array", - "items": { + }, + "desired_rx1_data_rate_offset": { "type": "object", "properties": { - "contact_method": { + "value": { "type": "string", - "default": "CONTACT_METHOD_OTHER", + "default": "DATA_RATE_OFFSET_0", "enum": [ - "CONTACT_METHOD_OTHER", - "CONTACT_METHOD_EMAIL", - "CONTACT_METHOD_PHONE" + "DATA_RATE_OFFSET_0", + "DATA_RATE_OFFSET_1", + "DATA_RATE_OFFSET_2", + "DATA_RATE_OFFSET_3", + "DATA_RATE_OFFSET_4", + "DATA_RATE_OFFSET_5", + "DATA_RATE_OFFSET_6", + "DATA_RATE_OFFSET_7" ] - }, - "contact_type": { + } + } + }, + "desired_rx1_delay": { + "type": "object", + "properties": { + "value": { + "description": " - RX_DELAY_0: 1 second.\n - RX_DELAY_1: 1 second.\n - RX_DELAY_2: 2 seconds.\n - RX_DELAY_3: 3 seconds.\n - RX_DELAY_4: 4 seconds.\n - RX_DELAY_5: 5 seconds.\n - RX_DELAY_6: 6 seconds.\n - RX_DELAY_7: 7 seconds.\n - RX_DELAY_8: 8 seconds.\n - RX_DELAY_9: 9 seconds.\n - RX_DELAY_10: 10 seconds.\n - RX_DELAY_11: 11 seconds.\n - RX_DELAY_12: 12 seconds.\n - RX_DELAY_13: 13 seconds.\n - RX_DELAY_14: 14 seconds.\n - RX_DELAY_15: 15 seconds.", "type": "string", - "default": "CONTACT_TYPE_OTHER", + "default": "RX_DELAY_0", "enum": [ - "CONTACT_TYPE_OTHER", - "CONTACT_TYPE_ABUSE", - "CONTACT_TYPE_BILLING", - "CONTACT_TYPE_TECHNICAL" + "RX_DELAY_0", + "RX_DELAY_1", + "RX_DELAY_2", + "RX_DELAY_3", + "RX_DELAY_4", + "RX_DELAY_5", + "RX_DELAY_6", + "RX_DELAY_7", + "RX_DELAY_8", + "RX_DELAY_9", + "RX_DELAY_10", + "RX_DELAY_11", + "RX_DELAY_12", + "RX_DELAY_13", + "RX_DELAY_14", + "RX_DELAY_15" ] - }, - "public": { + } + } + }, + "desired_rx2_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "desired_rx2_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "downlink_dwell_time": { + "type": "object", + "properties": { + "value": { "type": "boolean" - }, - "validated_at": { + } + } + }, + "factory_preset_frequencies": { + "description": "List of factory-preset frequencies.\nIf unset, the default value from Network Server configuration or regional parameters specification will be used.", + "type": "array", + "items": { + "type": "string", + "format": "uint64" + } + }, + "max_duty_cycle": { + "type": "object", + "properties": { + "value": { + "description": " - DUTY_CYCLE_1: 100%.\n - DUTY_CYCLE_2: 50%.\n - DUTY_CYCLE_4: 25%.\n - DUTY_CYCLE_8: 12.5%.\n - DUTY_CYCLE_16: 6.25%.\n - DUTY_CYCLE_32: 3.125%.\n - DUTY_CYCLE_64: 1.5625%.\n - DUTY_CYCLE_128: Roughly 0.781%.\n - DUTY_CYCLE_256: Roughly 0.390%.\n - DUTY_CYCLE_512: Roughly 0.195%.\n - DUTY_CYCLE_1024: Roughly 0.098%.\n - DUTY_CYCLE_2048: Roughly 0.049%.\n - DUTY_CYCLE_4096: Roughly 0.024%.\n - DUTY_CYCLE_8192: Roughly 0.012%.\n - DUTY_CYCLE_16384: Roughly 0.006%.\n - DUTY_CYCLE_32768: Roughly 0.003%.", "type": "string", - "format": "date-time" - }, + "default": "DUTY_CYCLE_1", + "enum": [ + "DUTY_CYCLE_1", + "DUTY_CYCLE_2", + "DUTY_CYCLE_4", + "DUTY_CYCLE_8", + "DUTY_CYCLE_16", + "DUTY_CYCLE_32", + "DUTY_CYCLE_64", + "DUTY_CYCLE_128", + "DUTY_CYCLE_256", + "DUTY_CYCLE_512", + "DUTY_CYCLE_1024", + "DUTY_CYCLE_2048", + "DUTY_CYCLE_4096", + "DUTY_CYCLE_8192", + "DUTY_CYCLE_16384", + "DUTY_CYCLE_32768" + ] + } + } + }, + "ping_slot_data_rate_index": { + "type": "object", + "properties": { "value": { - "type": "string" + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] } } - } - }, - "created_at": { - "description": "When the application was created. This information is public and can be seen by any authenticated user in the network.", - "type": "string", - "format": "date-time" - }, - "deleted_at": { - "description": "When the application was deleted. This information is public and can be seen by any authenticated user in the network.", - "type": "string", - "format": "date-time" - }, - "description": { - "description": "A description for the application.", - "type": "string" - }, - "dev_eui_counter": { - "type": "integer", - "format": "int64" - }, - "end_device_limit": { - "description": "The limit of the number of end devices that can be registered for this application.\nThis field can only be modified by admins.", - "type": "string", - "format": "uint64" - }, - "ids": { - "type": "object", - "properties": { - "application_id": { - "type": "string" + }, + "ping_slot_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } } - } - }, - "join_server_address": { - "description": "The address of the Join Server where this application is supposed to be registered.\nIf set, this fields indicates where end devices for this application should be registered.\n\nStored in Entity Registry.\nThe typical format of the address is \"host:port\". If the port is omitted,\nthe normal port inference (with DNS lookup, otherwise defaults) is used.\nThe connection shall be established with transport layer security (TLS).\nCustom certificate authorities may be configured out-of-band.", - "type": "string" - }, - "name": { - "description": "The name of the application.", - "type": "string" - }, - "network_server_address": { - "description": "The address of the Network Server where this application is supposed to be registered.\nIf set, this fields indicates where end devices for this application should be registered.\n\nStored in Entity Registry.\nThe typical format of the address is \"host:port\". If the port is omitted,\nthe normal port inference (with DNS lookup, otherwise defaults) is used.\nThe connection shall be established with transport layer security (TLS).\nCustom certificate authorities may be configured out-of-band.", - "type": "string" - }, - "technical_contact": { - "description": "OrganizationOrUserIdentifiers contains either organization or user identifiers.", - "type": "object", - "properties": { - "organization_ids": { - "type": "object", - "properties": { - "organization_id": { - "description": "This ID shares namespace with user IDs.", - "type": "string" - } + }, + "ping_slot_periodicity": { + "type": "object", + "properties": { + "value": { + "description": " - PING_EVERY_1S: Every second.\n - PING_EVERY_2S: Every 2 seconds.\n - PING_EVERY_4S: Every 4 seconds.\n - PING_EVERY_8S: Every 8 seconds.\n - PING_EVERY_16S: Every 16 seconds.\n - PING_EVERY_32S: Every 32 seconds.\n - PING_EVERY_64S: Every 64 seconds.\n - PING_EVERY_128S: Every 128 seconds.", + "type": "string", + "default": "PING_EVERY_1S", + "enum": [ + "PING_EVERY_1S", + "PING_EVERY_2S", + "PING_EVERY_4S", + "PING_EVERY_8S", + "PING_EVERY_16S", + "PING_EVERY_32S", + "PING_EVERY_64S", + "PING_EVERY_128S" + ] } - }, - "user_ids": { - "type": "object", - "properties": { - "email": { - "description": "Secondary identifier, which can only be used in specific requests.", - "type": "string" - }, - "user_id": { - "description": "This ID shares namespace with organization IDs.", - "type": "string" + } + }, + "relay": { + "description": "RelaySettings represent the settings of a relay.\nThis is used internally by the Network Server.", + "type": "object", + "properties": { + "served": { + "type": "object", + "properties": { + "always": { + "type": "object" + }, + "backoff": { + "description": "Number of wake on radio frames to be sent without an acknowledgement before sending the uplink message directly.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "dynamic": { + "type": "object", + "properties": { + "smart_enable_level": { + "type": "string", + "default": "RELAY_SMART_ENABLE_LEVEL_8", + "enum": [ + "RELAY_SMART_ENABLE_LEVEL_8", + "RELAY_SMART_ENABLE_LEVEL_16", + "RELAY_SMART_ENABLE_LEVEL_32", + "RELAY_SMART_ENABLE_LEVEL_64" + ] + } + } + }, + "end_device_controlled": { + "type": "object" + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "serving_device_id": { + "description": "End device identifier of the serving end device.", + "type": "string" + } + } + }, + "serving": { + "type": "object", + "properties": { + "cad_periodicity": { + "type": "string", + "title": "- RELAY_CAD_PERIODICITY_20_MILLISECONDS: sic", + "default": "RELAY_CAD_PERIODICITY_1_SECOND", + "enum": [ + "RELAY_CAD_PERIODICITY_1_SECOND", + "RELAY_CAD_PERIODICITY_500_MILLISECONDS", + "RELAY_CAD_PERIODICITY_250_MILLISECONDS", + "RELAY_CAD_PERIODICITY_100_MILLISECONDS", + "RELAY_CAD_PERIODICITY_50_MILLISECONDS", + "RELAY_CAD_PERIODICITY_20_MILLISECONDS" + ] + }, + "default_channel_index": { + "description": "Index of the default wake on radio channel.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "join_requests": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "notifications": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "overall": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "reset_behavior": { + "type": "string", + "default": "RELAY_RESET_LIMIT_COUNTER_ZERO", + "enum": [ + "RELAY_RESET_LIMIT_COUNTER_ZERO", + "RELAY_RESET_LIMIT_COUNTER_RELOAD_RATE", + "RELAY_RESET_LIMIT_COUNTER_MAX_VALUE", + "RELAY_RESET_LIMIT_COUNTER_NO_RESET" + ] + }, + "uplink_messages": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + } + } + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "uplink_forwarding_rules": { + "description": "Configured uplink forwarding rules.", + "type": "array", + "items": { + "type": "object", + "properties": { + "device_id": { + "description": "End device identifier of the served end device.", + "type": "string" + }, + "last_w_f_cnt": { + "description": "Last wake on radio frame counter used by the served end device.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "session_key_id": { + "description": "Session key ID of the session keys used to derive the root relay session key.", + "type": "string", + "format": "byte" + } + } + } + } } } } + }, + "resets_f_cnt": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "rx1_data_rate_offset": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_OFFSET_0", + "enum": [ + "DATA_RATE_OFFSET_0", + "DATA_RATE_OFFSET_1", + "DATA_RATE_OFFSET_2", + "DATA_RATE_OFFSET_3", + "DATA_RATE_OFFSET_4", + "DATA_RATE_OFFSET_5", + "DATA_RATE_OFFSET_6", + "DATA_RATE_OFFSET_7" + ] + } + } + }, + "rx1_delay": { + "type": "object", + "properties": { + "value": { + "description": " - RX_DELAY_0: 1 second.\n - RX_DELAY_1: 1 second.\n - RX_DELAY_2: 2 seconds.\n - RX_DELAY_3: 3 seconds.\n - RX_DELAY_4: 4 seconds.\n - RX_DELAY_5: 5 seconds.\n - RX_DELAY_6: 6 seconds.\n - RX_DELAY_7: 7 seconds.\n - RX_DELAY_8: 8 seconds.\n - RX_DELAY_9: 9 seconds.\n - RX_DELAY_10: 10 seconds.\n - RX_DELAY_11: 11 seconds.\n - RX_DELAY_12: 12 seconds.\n - RX_DELAY_13: 13 seconds.\n - RX_DELAY_14: 14 seconds.\n - RX_DELAY_15: 15 seconds.", + "type": "string", + "default": "RX_DELAY_0", + "enum": [ + "RX_DELAY_0", + "RX_DELAY_1", + "RX_DELAY_2", + "RX_DELAY_3", + "RX_DELAY_4", + "RX_DELAY_5", + "RX_DELAY_6", + "RX_DELAY_7", + "RX_DELAY_8", + "RX_DELAY_9", + "RX_DELAY_10", + "RX_DELAY_11", + "RX_DELAY_12", + "RX_DELAY_13", + "RX_DELAY_14", + "RX_DELAY_15" + ] + } + } + }, + "rx2_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "rx2_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "schedule_downlinks": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "status_count_periodicity": { + "description": "Number of uplink messages after which a DevStatusReq MACCommand shall be sent.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "status_time_periodicity": { + "description": "The interval after which a DevStatusReq MACCommand shall be sent.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "supports_32_bit_f_cnt": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "uplink_dwell_time": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "use_adr": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } } - }, - "updated_at": { - "description": "When the application was last updated. This information is public and can be seen by any authenticated user in the network.", - "type": "string", - "format": "date-time" } } } @@ -420699,18 +425912,5487 @@ } } }, - "post": { - "description": "This also sets the given organization or user as\nfirst collaborator with all possible rights.", + "put": { "tags": [ - "ApplicationRegistry" + "NsMACSettingsProfileRegistry" ], - "summary": "Create a new application.", - "operationId": "ApplicationRegistry_Create2", + "summary": "Update updates the MAC settings profile that matches the given identifiers.", + "operationId": "NsMACSettingsProfileRegistry_Update", "parameters": [ { "type": "string", - "description": "This ID shares namespace with user IDs.", - "name": "collaborator.organization_ids.organization_id", + "name": "mac_settings_profile_ids.application_ids.application_id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "Profile ID.", + "name": "mac_settings_profile_ids.profile_id", + "in": "path", + "required": true + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "field_mask": { + "description": "The names of the fields that should be updated.", + "type": "string" + }, + "mac_settings_profile": { + "type": "object", + "properties": { + "ids": { + "type": "object", + "properties": { + "application_ids": { + "type": "object", + "properties": { + "application_id": { + "type": "string" + } + } + }, + "profile_id": { + "description": "Profile ID.", + "type": "string" + } + } + }, + "mac_settings": { + "type": "object", + "properties": { + "adr": { + "description": "Adaptive Data Rate settings.", + "type": "object", + "properties": { + "disabled": { + "description": "Configuration options for cases in which ADR is to be disabled\ncompletely.", + "type": "object" + }, + "dynamic": { + "description": "Configuration options for dynamic ADR.", + "type": "object", + "properties": { + "channel_steering": { + "description": "EXPERIMENTAL: Channel steering settings.", + "type": "object", + "properties": { + "disabled": { + "description": "Configuration options for cases in which ADR is not supposed to steer the end device\nto another set of channels.", + "type": "object" + }, + "lora_narrow": { + "description": "Configuration options for LoRa narrow channels steering.\nThe narrow mode attempts to steer the end device towards\nusing the LoRa modulated, 125kHz bandwidth channels.", + "type": "object" + } + } + }, + "margin": { + "description": "The ADR margin (dB) tells the network server how much margin it should add in ADR requests.\nA bigger margin is less efficient, but gives a better chance of successful reception.\nIf unset, the default value from Network Server configuration will be used.", + "type": "number", + "format": "float" + }, + "max_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "max_tx_power_index": { + "description": "Maximum transmission power index.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_tx_power_index": { + "description": "Minimum transmission power index.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "overrides": { + "description": "EXPERIMENTAL: Configuration overrides.", + "type": "object", + "properties": { + "data_rate_0": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_1": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_10": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_11": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_12": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_13": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_14": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_15": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_2": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_3": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_4": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_5": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_6": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_7": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_8": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_9": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + } + } + } + } + }, + "static": { + "description": "Configuration options for static ADR.", + "type": "object", + "properties": { + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "nb_trans": { + "description": "Number of retransmissions.", + "type": "integer", + "format": "int64" + }, + "tx_power_index": { + "description": "Transmission power index to use.", + "type": "integer", + "format": "int64" + } + } + } + } + }, + "adr_margin": { + "description": "The ADR margin (dB) tells the network server how much margin it should add in ADR requests.\nA bigger margin is less efficient, but gives a better chance of successful reception.\nThis field is deprecated, use adr_settings.dynamic.margin instead.", + "type": "number", + "format": "float" + }, + "beacon_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "class_b_c_downlink_interval": { + "description": "The minimum duration passed before a network-initiated(e.g. Class B or C) downlink following an arbitrary downlink.", + "type": "string" + }, + "class_b_timeout": { + "description": "Maximum delay for the device to answer a MAC request or a confirmed downlink frame.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "class_c_timeout": { + "description": "Maximum delay for the device to answer a MAC request or a confirmed downlink frame.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "desired_adr_ack_delay_exponent": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "ADR_ACK_DELAY_1", + "enum": [ + "ADR_ACK_DELAY_1", + "ADR_ACK_DELAY_2", + "ADR_ACK_DELAY_4", + "ADR_ACK_DELAY_8", + "ADR_ACK_DELAY_16", + "ADR_ACK_DELAY_32", + "ADR_ACK_DELAY_64", + "ADR_ACK_DELAY_128", + "ADR_ACK_DELAY_256", + "ADR_ACK_DELAY_512", + "ADR_ACK_DELAY_1024", + "ADR_ACK_DELAY_2048", + "ADR_ACK_DELAY_4096", + "ADR_ACK_DELAY_8192", + "ADR_ACK_DELAY_16384", + "ADR_ACK_DELAY_32768" + ] + } + } + }, + "desired_adr_ack_limit_exponent": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "ADR_ACK_LIMIT_1", + "enum": [ + "ADR_ACK_LIMIT_1", + "ADR_ACK_LIMIT_2", + "ADR_ACK_LIMIT_4", + "ADR_ACK_LIMIT_8", + "ADR_ACK_LIMIT_16", + "ADR_ACK_LIMIT_32", + "ADR_ACK_LIMIT_64", + "ADR_ACK_LIMIT_128", + "ADR_ACK_LIMIT_256", + "ADR_ACK_LIMIT_512", + "ADR_ACK_LIMIT_1024", + "ADR_ACK_LIMIT_2048", + "ADR_ACK_LIMIT_4096", + "ADR_ACK_LIMIT_8192", + "ADR_ACK_LIMIT_16384", + "ADR_ACK_LIMIT_32768" + ] + } + } + }, + "desired_beacon_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "desired_max_duty_cycle": { + "type": "object", + "properties": { + "value": { + "description": " - DUTY_CYCLE_1: 100%.\n - DUTY_CYCLE_2: 50%.\n - DUTY_CYCLE_4: 25%.\n - DUTY_CYCLE_8: 12.5%.\n - DUTY_CYCLE_16: 6.25%.\n - DUTY_CYCLE_32: 3.125%.\n - DUTY_CYCLE_64: 1.5625%.\n - DUTY_CYCLE_128: Roughly 0.781%.\n - DUTY_CYCLE_256: Roughly 0.390%.\n - DUTY_CYCLE_512: Roughly 0.195%.\n - DUTY_CYCLE_1024: Roughly 0.098%.\n - DUTY_CYCLE_2048: Roughly 0.049%.\n - DUTY_CYCLE_4096: Roughly 0.024%.\n - DUTY_CYCLE_8192: Roughly 0.012%.\n - DUTY_CYCLE_16384: Roughly 0.006%.\n - DUTY_CYCLE_32768: Roughly 0.003%.", + "type": "string", + "default": "DUTY_CYCLE_1", + "enum": [ + "DUTY_CYCLE_1", + "DUTY_CYCLE_2", + "DUTY_CYCLE_4", + "DUTY_CYCLE_8", + "DUTY_CYCLE_16", + "DUTY_CYCLE_32", + "DUTY_CYCLE_64", + "DUTY_CYCLE_128", + "DUTY_CYCLE_256", + "DUTY_CYCLE_512", + "DUTY_CYCLE_1024", + "DUTY_CYCLE_2048", + "DUTY_CYCLE_4096", + "DUTY_CYCLE_8192", + "DUTY_CYCLE_16384", + "DUTY_CYCLE_32768" + ] + } + } + }, + "desired_max_eirp": { + "type": "object", + "properties": { + "value": { + "description": " - DEVICE_EIRP_8: 8 dBm.\n - DEVICE_EIRP_10: 10 dBm.\n - DEVICE_EIRP_12: 12 dBm.\n - DEVICE_EIRP_13: 13 dBm.\n - DEVICE_EIRP_14: 14 dBm.\n - DEVICE_EIRP_16: 16 dBm.\n - DEVICE_EIRP_18: 18 dBm.\n - DEVICE_EIRP_20: 20 dBm.\n - DEVICE_EIRP_21: 21 dBm.\n - DEVICE_EIRP_24: 24 dBm.\n - DEVICE_EIRP_26: 26 dBm.\n - DEVICE_EIRP_27: 27 dBm.\n - DEVICE_EIRP_29: 29 dBm.\n - DEVICE_EIRP_30: 30 dBm.\n - DEVICE_EIRP_33: 33 dBm.\n - DEVICE_EIRP_36: 36 dBm.", + "type": "string", + "default": "DEVICE_EIRP_8", + "enum": [ + "DEVICE_EIRP_8", + "DEVICE_EIRP_10", + "DEVICE_EIRP_12", + "DEVICE_EIRP_13", + "DEVICE_EIRP_14", + "DEVICE_EIRP_16", + "DEVICE_EIRP_18", + "DEVICE_EIRP_20", + "DEVICE_EIRP_21", + "DEVICE_EIRP_24", + "DEVICE_EIRP_26", + "DEVICE_EIRP_27", + "DEVICE_EIRP_29", + "DEVICE_EIRP_30", + "DEVICE_EIRP_33", + "DEVICE_EIRP_36" + ] + } + } + }, + "desired_ping_slot_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "desired_ping_slot_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "desired_relay": { + "description": "RelaySettings represent the settings of a relay.\nThis is used internally by the Network Server.", + "type": "object", + "properties": { + "served": { + "type": "object", + "properties": { + "always": { + "type": "object" + }, + "backoff": { + "description": "Number of wake on radio frames to be sent without an acknowledgement before sending the uplink message directly.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "dynamic": { + "type": "object", + "properties": { + "smart_enable_level": { + "type": "string", + "default": "RELAY_SMART_ENABLE_LEVEL_8", + "enum": [ + "RELAY_SMART_ENABLE_LEVEL_8", + "RELAY_SMART_ENABLE_LEVEL_16", + "RELAY_SMART_ENABLE_LEVEL_32", + "RELAY_SMART_ENABLE_LEVEL_64" + ] + } + } + }, + "end_device_controlled": { + "type": "object" + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "serving_device_id": { + "description": "End device identifier of the serving end device.", + "type": "string" + } + } + }, + "serving": { + "type": "object", + "properties": { + "cad_periodicity": { + "type": "string", + "title": "- RELAY_CAD_PERIODICITY_20_MILLISECONDS: sic", + "default": "RELAY_CAD_PERIODICITY_1_SECOND", + "enum": [ + "RELAY_CAD_PERIODICITY_1_SECOND", + "RELAY_CAD_PERIODICITY_500_MILLISECONDS", + "RELAY_CAD_PERIODICITY_250_MILLISECONDS", + "RELAY_CAD_PERIODICITY_100_MILLISECONDS", + "RELAY_CAD_PERIODICITY_50_MILLISECONDS", + "RELAY_CAD_PERIODICITY_20_MILLISECONDS" + ] + }, + "default_channel_index": { + "description": "Index of the default wake on radio channel.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "join_requests": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "notifications": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "overall": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "reset_behavior": { + "type": "string", + "default": "RELAY_RESET_LIMIT_COUNTER_ZERO", + "enum": [ + "RELAY_RESET_LIMIT_COUNTER_ZERO", + "RELAY_RESET_LIMIT_COUNTER_RELOAD_RATE", + "RELAY_RESET_LIMIT_COUNTER_MAX_VALUE", + "RELAY_RESET_LIMIT_COUNTER_NO_RESET" + ] + }, + "uplink_messages": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + } + } + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "uplink_forwarding_rules": { + "description": "Configured uplink forwarding rules.", + "type": "array", + "items": { + "type": "object", + "properties": { + "device_id": { + "description": "End device identifier of the served end device.", + "type": "string" + }, + "last_w_f_cnt": { + "description": "Last wake on radio frame counter used by the served end device.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "session_key_id": { + "description": "Session key ID of the session keys used to derive the root relay session key.", + "type": "string", + "format": "byte" + } + } + } + } + } + } + } + }, + "desired_rx1_data_rate_offset": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_OFFSET_0", + "enum": [ + "DATA_RATE_OFFSET_0", + "DATA_RATE_OFFSET_1", + "DATA_RATE_OFFSET_2", + "DATA_RATE_OFFSET_3", + "DATA_RATE_OFFSET_4", + "DATA_RATE_OFFSET_5", + "DATA_RATE_OFFSET_6", + "DATA_RATE_OFFSET_7" + ] + } + } + }, + "desired_rx1_delay": { + "type": "object", + "properties": { + "value": { + "description": " - RX_DELAY_0: 1 second.\n - RX_DELAY_1: 1 second.\n - RX_DELAY_2: 2 seconds.\n - RX_DELAY_3: 3 seconds.\n - RX_DELAY_4: 4 seconds.\n - RX_DELAY_5: 5 seconds.\n - RX_DELAY_6: 6 seconds.\n - RX_DELAY_7: 7 seconds.\n - RX_DELAY_8: 8 seconds.\n - RX_DELAY_9: 9 seconds.\n - RX_DELAY_10: 10 seconds.\n - RX_DELAY_11: 11 seconds.\n - RX_DELAY_12: 12 seconds.\n - RX_DELAY_13: 13 seconds.\n - RX_DELAY_14: 14 seconds.\n - RX_DELAY_15: 15 seconds.", + "type": "string", + "default": "RX_DELAY_0", + "enum": [ + "RX_DELAY_0", + "RX_DELAY_1", + "RX_DELAY_2", + "RX_DELAY_3", + "RX_DELAY_4", + "RX_DELAY_5", + "RX_DELAY_6", + "RX_DELAY_7", + "RX_DELAY_8", + "RX_DELAY_9", + "RX_DELAY_10", + "RX_DELAY_11", + "RX_DELAY_12", + "RX_DELAY_13", + "RX_DELAY_14", + "RX_DELAY_15" + ] + } + } + }, + "desired_rx2_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "desired_rx2_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "downlink_dwell_time": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "factory_preset_frequencies": { + "description": "List of factory-preset frequencies.\nIf unset, the default value from Network Server configuration or regional parameters specification will be used.", + "type": "array", + "items": { + "type": "string", + "format": "uint64" + } + }, + "max_duty_cycle": { + "type": "object", + "properties": { + "value": { + "description": " - DUTY_CYCLE_1: 100%.\n - DUTY_CYCLE_2: 50%.\n - DUTY_CYCLE_4: 25%.\n - DUTY_CYCLE_8: 12.5%.\n - DUTY_CYCLE_16: 6.25%.\n - DUTY_CYCLE_32: 3.125%.\n - DUTY_CYCLE_64: 1.5625%.\n - DUTY_CYCLE_128: Roughly 0.781%.\n - DUTY_CYCLE_256: Roughly 0.390%.\n - DUTY_CYCLE_512: Roughly 0.195%.\n - DUTY_CYCLE_1024: Roughly 0.098%.\n - DUTY_CYCLE_2048: Roughly 0.049%.\n - DUTY_CYCLE_4096: Roughly 0.024%.\n - DUTY_CYCLE_8192: Roughly 0.012%.\n - DUTY_CYCLE_16384: Roughly 0.006%.\n - DUTY_CYCLE_32768: Roughly 0.003%.", + "type": "string", + "default": "DUTY_CYCLE_1", + "enum": [ + "DUTY_CYCLE_1", + "DUTY_CYCLE_2", + "DUTY_CYCLE_4", + "DUTY_CYCLE_8", + "DUTY_CYCLE_16", + "DUTY_CYCLE_32", + "DUTY_CYCLE_64", + "DUTY_CYCLE_128", + "DUTY_CYCLE_256", + "DUTY_CYCLE_512", + "DUTY_CYCLE_1024", + "DUTY_CYCLE_2048", + "DUTY_CYCLE_4096", + "DUTY_CYCLE_8192", + "DUTY_CYCLE_16384", + "DUTY_CYCLE_32768" + ] + } + } + }, + "ping_slot_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "ping_slot_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "ping_slot_periodicity": { + "type": "object", + "properties": { + "value": { + "description": " - PING_EVERY_1S: Every second.\n - PING_EVERY_2S: Every 2 seconds.\n - PING_EVERY_4S: Every 4 seconds.\n - PING_EVERY_8S: Every 8 seconds.\n - PING_EVERY_16S: Every 16 seconds.\n - PING_EVERY_32S: Every 32 seconds.\n - PING_EVERY_64S: Every 64 seconds.\n - PING_EVERY_128S: Every 128 seconds.", + "type": "string", + "default": "PING_EVERY_1S", + "enum": [ + "PING_EVERY_1S", + "PING_EVERY_2S", + "PING_EVERY_4S", + "PING_EVERY_8S", + "PING_EVERY_16S", + "PING_EVERY_32S", + "PING_EVERY_64S", + "PING_EVERY_128S" + ] + } + } + }, + "relay": { + "description": "RelaySettings represent the settings of a relay.\nThis is used internally by the Network Server.", + "type": "object", + "properties": { + "served": { + "type": "object", + "properties": { + "always": { + "type": "object" + }, + "backoff": { + "description": "Number of wake on radio frames to be sent without an acknowledgement before sending the uplink message directly.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "dynamic": { + "type": "object", + "properties": { + "smart_enable_level": { + "type": "string", + "default": "RELAY_SMART_ENABLE_LEVEL_8", + "enum": [ + "RELAY_SMART_ENABLE_LEVEL_8", + "RELAY_SMART_ENABLE_LEVEL_16", + "RELAY_SMART_ENABLE_LEVEL_32", + "RELAY_SMART_ENABLE_LEVEL_64" + ] + } + } + }, + "end_device_controlled": { + "type": "object" + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "serving_device_id": { + "description": "End device identifier of the serving end device.", + "type": "string" + } + } + }, + "serving": { + "type": "object", + "properties": { + "cad_periodicity": { + "type": "string", + "title": "- RELAY_CAD_PERIODICITY_20_MILLISECONDS: sic", + "default": "RELAY_CAD_PERIODICITY_1_SECOND", + "enum": [ + "RELAY_CAD_PERIODICITY_1_SECOND", + "RELAY_CAD_PERIODICITY_500_MILLISECONDS", + "RELAY_CAD_PERIODICITY_250_MILLISECONDS", + "RELAY_CAD_PERIODICITY_100_MILLISECONDS", + "RELAY_CAD_PERIODICITY_50_MILLISECONDS", + "RELAY_CAD_PERIODICITY_20_MILLISECONDS" + ] + }, + "default_channel_index": { + "description": "Index of the default wake on radio channel.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "join_requests": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "notifications": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "overall": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "reset_behavior": { + "type": "string", + "default": "RELAY_RESET_LIMIT_COUNTER_ZERO", + "enum": [ + "RELAY_RESET_LIMIT_COUNTER_ZERO", + "RELAY_RESET_LIMIT_COUNTER_RELOAD_RATE", + "RELAY_RESET_LIMIT_COUNTER_MAX_VALUE", + "RELAY_RESET_LIMIT_COUNTER_NO_RESET" + ] + }, + "uplink_messages": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + } + } + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "uplink_forwarding_rules": { + "description": "Configured uplink forwarding rules.", + "type": "array", + "items": { + "type": "object", + "properties": { + "device_id": { + "description": "End device identifier of the served end device.", + "type": "string" + }, + "last_w_f_cnt": { + "description": "Last wake on radio frame counter used by the served end device.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "session_key_id": { + "description": "Session key ID of the session keys used to derive the root relay session key.", + "type": "string", + "format": "byte" + } + } + } + } + } + } + } + }, + "resets_f_cnt": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "rx1_data_rate_offset": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_OFFSET_0", + "enum": [ + "DATA_RATE_OFFSET_0", + "DATA_RATE_OFFSET_1", + "DATA_RATE_OFFSET_2", + "DATA_RATE_OFFSET_3", + "DATA_RATE_OFFSET_4", + "DATA_RATE_OFFSET_5", + "DATA_RATE_OFFSET_6", + "DATA_RATE_OFFSET_7" + ] + } + } + }, + "rx1_delay": { + "type": "object", + "properties": { + "value": { + "description": " - RX_DELAY_0: 1 second.\n - RX_DELAY_1: 1 second.\n - RX_DELAY_2: 2 seconds.\n - RX_DELAY_3: 3 seconds.\n - RX_DELAY_4: 4 seconds.\n - RX_DELAY_5: 5 seconds.\n - RX_DELAY_6: 6 seconds.\n - RX_DELAY_7: 7 seconds.\n - RX_DELAY_8: 8 seconds.\n - RX_DELAY_9: 9 seconds.\n - RX_DELAY_10: 10 seconds.\n - RX_DELAY_11: 11 seconds.\n - RX_DELAY_12: 12 seconds.\n - RX_DELAY_13: 13 seconds.\n - RX_DELAY_14: 14 seconds.\n - RX_DELAY_15: 15 seconds.", + "type": "string", + "default": "RX_DELAY_0", + "enum": [ + "RX_DELAY_0", + "RX_DELAY_1", + "RX_DELAY_2", + "RX_DELAY_3", + "RX_DELAY_4", + "RX_DELAY_5", + "RX_DELAY_6", + "RX_DELAY_7", + "RX_DELAY_8", + "RX_DELAY_9", + "RX_DELAY_10", + "RX_DELAY_11", + "RX_DELAY_12", + "RX_DELAY_13", + "RX_DELAY_14", + "RX_DELAY_15" + ] + } + } + }, + "rx2_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "rx2_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "schedule_downlinks": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "status_count_periodicity": { + "description": "Number of uplink messages after which a DevStatusReq MACCommand shall be sent.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "status_time_periodicity": { + "description": "The interval after which a DevStatusReq MACCommand shall be sent.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "supports_32_bit_f_cnt": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "uplink_dwell_time": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "use_adr": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + } + } + } + } + }, + "mac_settings_profile_ids": { + "description": "The identifiers of the MAC settings profile.", + "type": "object", + "title": "The identifiers of the MAC settings profile.", + "properties": { + "application_ids": { + "description": "Application IDs.", + "type": "object", + "title": "Application IDs." + } + } + } + } + } + } + ], + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "type": "object", + "properties": { + "mac_settings_profile": { + "type": "object", + "properties": { + "ids": { + "type": "object", + "properties": { + "application_ids": { + "type": "object", + "properties": { + "application_id": { + "type": "string" + } + } + }, + "profile_id": { + "description": "Profile ID.", + "type": "string" + } + } + }, + "mac_settings": { + "type": "object", + "properties": { + "adr": { + "description": "Adaptive Data Rate settings.", + "type": "object", + "properties": { + "disabled": { + "description": "Configuration options for cases in which ADR is to be disabled\ncompletely.", + "type": "object" + }, + "dynamic": { + "description": "Configuration options for dynamic ADR.", + "type": "object", + "properties": { + "channel_steering": { + "description": "EXPERIMENTAL: Channel steering settings.", + "type": "object", + "properties": { + "disabled": { + "description": "Configuration options for cases in which ADR is not supposed to steer the end device\nto another set of channels.", + "type": "object" + }, + "lora_narrow": { + "description": "Configuration options for LoRa narrow channels steering.\nThe narrow mode attempts to steer the end device towards\nusing the LoRa modulated, 125kHz bandwidth channels.", + "type": "object" + } + } + }, + "margin": { + "description": "The ADR margin (dB) tells the network server how much margin it should add in ADR requests.\nA bigger margin is less efficient, but gives a better chance of successful reception.\nIf unset, the default value from Network Server configuration will be used.", + "type": "number", + "format": "float" + }, + "max_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "max_tx_power_index": { + "description": "Maximum transmission power index.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_tx_power_index": { + "description": "Minimum transmission power index.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "overrides": { + "description": "EXPERIMENTAL: Configuration overrides.", + "type": "object", + "properties": { + "data_rate_0": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_1": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_10": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_11": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_12": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_13": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_14": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_15": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_2": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_3": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_4": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_5": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_6": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_7": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_8": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_9": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + } + } + } + } + }, + "static": { + "description": "Configuration options for static ADR.", + "type": "object", + "properties": { + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "nb_trans": { + "description": "Number of retransmissions.", + "type": "integer", + "format": "int64" + }, + "tx_power_index": { + "description": "Transmission power index to use.", + "type": "integer", + "format": "int64" + } + } + } + } + }, + "adr_margin": { + "description": "The ADR margin (dB) tells the network server how much margin it should add in ADR requests.\nA bigger margin is less efficient, but gives a better chance of successful reception.\nThis field is deprecated, use adr_settings.dynamic.margin instead.", + "type": "number", + "format": "float" + }, + "beacon_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "class_b_c_downlink_interval": { + "description": "The minimum duration passed before a network-initiated(e.g. Class B or C) downlink following an arbitrary downlink.", + "type": "string" + }, + "class_b_timeout": { + "description": "Maximum delay for the device to answer a MAC request or a confirmed downlink frame.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "class_c_timeout": { + "description": "Maximum delay for the device to answer a MAC request or a confirmed downlink frame.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "desired_adr_ack_delay_exponent": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "ADR_ACK_DELAY_1", + "enum": [ + "ADR_ACK_DELAY_1", + "ADR_ACK_DELAY_2", + "ADR_ACK_DELAY_4", + "ADR_ACK_DELAY_8", + "ADR_ACK_DELAY_16", + "ADR_ACK_DELAY_32", + "ADR_ACK_DELAY_64", + "ADR_ACK_DELAY_128", + "ADR_ACK_DELAY_256", + "ADR_ACK_DELAY_512", + "ADR_ACK_DELAY_1024", + "ADR_ACK_DELAY_2048", + "ADR_ACK_DELAY_4096", + "ADR_ACK_DELAY_8192", + "ADR_ACK_DELAY_16384", + "ADR_ACK_DELAY_32768" + ] + } + } + }, + "desired_adr_ack_limit_exponent": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "ADR_ACK_LIMIT_1", + "enum": [ + "ADR_ACK_LIMIT_1", + "ADR_ACK_LIMIT_2", + "ADR_ACK_LIMIT_4", + "ADR_ACK_LIMIT_8", + "ADR_ACK_LIMIT_16", + "ADR_ACK_LIMIT_32", + "ADR_ACK_LIMIT_64", + "ADR_ACK_LIMIT_128", + "ADR_ACK_LIMIT_256", + "ADR_ACK_LIMIT_512", + "ADR_ACK_LIMIT_1024", + "ADR_ACK_LIMIT_2048", + "ADR_ACK_LIMIT_4096", + "ADR_ACK_LIMIT_8192", + "ADR_ACK_LIMIT_16384", + "ADR_ACK_LIMIT_32768" + ] + } + } + }, + "desired_beacon_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "desired_max_duty_cycle": { + "type": "object", + "properties": { + "value": { + "description": " - DUTY_CYCLE_1: 100%.\n - DUTY_CYCLE_2: 50%.\n - DUTY_CYCLE_4: 25%.\n - DUTY_CYCLE_8: 12.5%.\n - DUTY_CYCLE_16: 6.25%.\n - DUTY_CYCLE_32: 3.125%.\n - DUTY_CYCLE_64: 1.5625%.\n - DUTY_CYCLE_128: Roughly 0.781%.\n - DUTY_CYCLE_256: Roughly 0.390%.\n - DUTY_CYCLE_512: Roughly 0.195%.\n - DUTY_CYCLE_1024: Roughly 0.098%.\n - DUTY_CYCLE_2048: Roughly 0.049%.\n - DUTY_CYCLE_4096: Roughly 0.024%.\n - DUTY_CYCLE_8192: Roughly 0.012%.\n - DUTY_CYCLE_16384: Roughly 0.006%.\n - DUTY_CYCLE_32768: Roughly 0.003%.", + "type": "string", + "default": "DUTY_CYCLE_1", + "enum": [ + "DUTY_CYCLE_1", + "DUTY_CYCLE_2", + "DUTY_CYCLE_4", + "DUTY_CYCLE_8", + "DUTY_CYCLE_16", + "DUTY_CYCLE_32", + "DUTY_CYCLE_64", + "DUTY_CYCLE_128", + "DUTY_CYCLE_256", + "DUTY_CYCLE_512", + "DUTY_CYCLE_1024", + "DUTY_CYCLE_2048", + "DUTY_CYCLE_4096", + "DUTY_CYCLE_8192", + "DUTY_CYCLE_16384", + "DUTY_CYCLE_32768" + ] + } + } + }, + "desired_max_eirp": { + "type": "object", + "properties": { + "value": { + "description": " - DEVICE_EIRP_8: 8 dBm.\n - DEVICE_EIRP_10: 10 dBm.\n - DEVICE_EIRP_12: 12 dBm.\n - DEVICE_EIRP_13: 13 dBm.\n - DEVICE_EIRP_14: 14 dBm.\n - DEVICE_EIRP_16: 16 dBm.\n - DEVICE_EIRP_18: 18 dBm.\n - DEVICE_EIRP_20: 20 dBm.\n - DEVICE_EIRP_21: 21 dBm.\n - DEVICE_EIRP_24: 24 dBm.\n - DEVICE_EIRP_26: 26 dBm.\n - DEVICE_EIRP_27: 27 dBm.\n - DEVICE_EIRP_29: 29 dBm.\n - DEVICE_EIRP_30: 30 dBm.\n - DEVICE_EIRP_33: 33 dBm.\n - DEVICE_EIRP_36: 36 dBm.", + "type": "string", + "default": "DEVICE_EIRP_8", + "enum": [ + "DEVICE_EIRP_8", + "DEVICE_EIRP_10", + "DEVICE_EIRP_12", + "DEVICE_EIRP_13", + "DEVICE_EIRP_14", + "DEVICE_EIRP_16", + "DEVICE_EIRP_18", + "DEVICE_EIRP_20", + "DEVICE_EIRP_21", + "DEVICE_EIRP_24", + "DEVICE_EIRP_26", + "DEVICE_EIRP_27", + "DEVICE_EIRP_29", + "DEVICE_EIRP_30", + "DEVICE_EIRP_33", + "DEVICE_EIRP_36" + ] + } + } + }, + "desired_ping_slot_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "desired_ping_slot_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "desired_relay": { + "description": "RelaySettings represent the settings of a relay.\nThis is used internally by the Network Server.", + "type": "object", + "properties": { + "served": { + "type": "object", + "properties": { + "always": { + "type": "object" + }, + "backoff": { + "description": "Number of wake on radio frames to be sent without an acknowledgement before sending the uplink message directly.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "dynamic": { + "type": "object", + "properties": { + "smart_enable_level": { + "type": "string", + "default": "RELAY_SMART_ENABLE_LEVEL_8", + "enum": [ + "RELAY_SMART_ENABLE_LEVEL_8", + "RELAY_SMART_ENABLE_LEVEL_16", + "RELAY_SMART_ENABLE_LEVEL_32", + "RELAY_SMART_ENABLE_LEVEL_64" + ] + } + } + }, + "end_device_controlled": { + "type": "object" + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "serving_device_id": { + "description": "End device identifier of the serving end device.", + "type": "string" + } + } + }, + "serving": { + "type": "object", + "properties": { + "cad_periodicity": { + "type": "string", + "title": "- RELAY_CAD_PERIODICITY_20_MILLISECONDS: sic", + "default": "RELAY_CAD_PERIODICITY_1_SECOND", + "enum": [ + "RELAY_CAD_PERIODICITY_1_SECOND", + "RELAY_CAD_PERIODICITY_500_MILLISECONDS", + "RELAY_CAD_PERIODICITY_250_MILLISECONDS", + "RELAY_CAD_PERIODICITY_100_MILLISECONDS", + "RELAY_CAD_PERIODICITY_50_MILLISECONDS", + "RELAY_CAD_PERIODICITY_20_MILLISECONDS" + ] + }, + "default_channel_index": { + "description": "Index of the default wake on radio channel.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "join_requests": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "notifications": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "overall": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "reset_behavior": { + "type": "string", + "default": "RELAY_RESET_LIMIT_COUNTER_ZERO", + "enum": [ + "RELAY_RESET_LIMIT_COUNTER_ZERO", + "RELAY_RESET_LIMIT_COUNTER_RELOAD_RATE", + "RELAY_RESET_LIMIT_COUNTER_MAX_VALUE", + "RELAY_RESET_LIMIT_COUNTER_NO_RESET" + ] + }, + "uplink_messages": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + } + } + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "uplink_forwarding_rules": { + "description": "Configured uplink forwarding rules.", + "type": "array", + "items": { + "type": "object", + "properties": { + "device_id": { + "description": "End device identifier of the served end device.", + "type": "string" + }, + "last_w_f_cnt": { + "description": "Last wake on radio frame counter used by the served end device.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "session_key_id": { + "description": "Session key ID of the session keys used to derive the root relay session key.", + "type": "string", + "format": "byte" + } + } + } + } + } + } + } + }, + "desired_rx1_data_rate_offset": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_OFFSET_0", + "enum": [ + "DATA_RATE_OFFSET_0", + "DATA_RATE_OFFSET_1", + "DATA_RATE_OFFSET_2", + "DATA_RATE_OFFSET_3", + "DATA_RATE_OFFSET_4", + "DATA_RATE_OFFSET_5", + "DATA_RATE_OFFSET_6", + "DATA_RATE_OFFSET_7" + ] + } + } + }, + "desired_rx1_delay": { + "type": "object", + "properties": { + "value": { + "description": " - RX_DELAY_0: 1 second.\n - RX_DELAY_1: 1 second.\n - RX_DELAY_2: 2 seconds.\n - RX_DELAY_3: 3 seconds.\n - RX_DELAY_4: 4 seconds.\n - RX_DELAY_5: 5 seconds.\n - RX_DELAY_6: 6 seconds.\n - RX_DELAY_7: 7 seconds.\n - RX_DELAY_8: 8 seconds.\n - RX_DELAY_9: 9 seconds.\n - RX_DELAY_10: 10 seconds.\n - RX_DELAY_11: 11 seconds.\n - RX_DELAY_12: 12 seconds.\n - RX_DELAY_13: 13 seconds.\n - RX_DELAY_14: 14 seconds.\n - RX_DELAY_15: 15 seconds.", + "type": "string", + "default": "RX_DELAY_0", + "enum": [ + "RX_DELAY_0", + "RX_DELAY_1", + "RX_DELAY_2", + "RX_DELAY_3", + "RX_DELAY_4", + "RX_DELAY_5", + "RX_DELAY_6", + "RX_DELAY_7", + "RX_DELAY_8", + "RX_DELAY_9", + "RX_DELAY_10", + "RX_DELAY_11", + "RX_DELAY_12", + "RX_DELAY_13", + "RX_DELAY_14", + "RX_DELAY_15" + ] + } + } + }, + "desired_rx2_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "desired_rx2_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "downlink_dwell_time": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "factory_preset_frequencies": { + "description": "List of factory-preset frequencies.\nIf unset, the default value from Network Server configuration or regional parameters specification will be used.", + "type": "array", + "items": { + "type": "string", + "format": "uint64" + } + }, + "max_duty_cycle": { + "type": "object", + "properties": { + "value": { + "description": " - DUTY_CYCLE_1: 100%.\n - DUTY_CYCLE_2: 50%.\n - DUTY_CYCLE_4: 25%.\n - DUTY_CYCLE_8: 12.5%.\n - DUTY_CYCLE_16: 6.25%.\n - DUTY_CYCLE_32: 3.125%.\n - DUTY_CYCLE_64: 1.5625%.\n - DUTY_CYCLE_128: Roughly 0.781%.\n - DUTY_CYCLE_256: Roughly 0.390%.\n - DUTY_CYCLE_512: Roughly 0.195%.\n - DUTY_CYCLE_1024: Roughly 0.098%.\n - DUTY_CYCLE_2048: Roughly 0.049%.\n - DUTY_CYCLE_4096: Roughly 0.024%.\n - DUTY_CYCLE_8192: Roughly 0.012%.\n - DUTY_CYCLE_16384: Roughly 0.006%.\n - DUTY_CYCLE_32768: Roughly 0.003%.", + "type": "string", + "default": "DUTY_CYCLE_1", + "enum": [ + "DUTY_CYCLE_1", + "DUTY_CYCLE_2", + "DUTY_CYCLE_4", + "DUTY_CYCLE_8", + "DUTY_CYCLE_16", + "DUTY_CYCLE_32", + "DUTY_CYCLE_64", + "DUTY_CYCLE_128", + "DUTY_CYCLE_256", + "DUTY_CYCLE_512", + "DUTY_CYCLE_1024", + "DUTY_CYCLE_2048", + "DUTY_CYCLE_4096", + "DUTY_CYCLE_8192", + "DUTY_CYCLE_16384", + "DUTY_CYCLE_32768" + ] + } + } + }, + "ping_slot_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "ping_slot_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "ping_slot_periodicity": { + "type": "object", + "properties": { + "value": { + "description": " - PING_EVERY_1S: Every second.\n - PING_EVERY_2S: Every 2 seconds.\n - PING_EVERY_4S: Every 4 seconds.\n - PING_EVERY_8S: Every 8 seconds.\n - PING_EVERY_16S: Every 16 seconds.\n - PING_EVERY_32S: Every 32 seconds.\n - PING_EVERY_64S: Every 64 seconds.\n - PING_EVERY_128S: Every 128 seconds.", + "type": "string", + "default": "PING_EVERY_1S", + "enum": [ + "PING_EVERY_1S", + "PING_EVERY_2S", + "PING_EVERY_4S", + "PING_EVERY_8S", + "PING_EVERY_16S", + "PING_EVERY_32S", + "PING_EVERY_64S", + "PING_EVERY_128S" + ] + } + } + }, + "relay": { + "description": "RelaySettings represent the settings of a relay.\nThis is used internally by the Network Server.", + "type": "object", + "properties": { + "served": { + "type": "object", + "properties": { + "always": { + "type": "object" + }, + "backoff": { + "description": "Number of wake on radio frames to be sent without an acknowledgement before sending the uplink message directly.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "dynamic": { + "type": "object", + "properties": { + "smart_enable_level": { + "type": "string", + "default": "RELAY_SMART_ENABLE_LEVEL_8", + "enum": [ + "RELAY_SMART_ENABLE_LEVEL_8", + "RELAY_SMART_ENABLE_LEVEL_16", + "RELAY_SMART_ENABLE_LEVEL_32", + "RELAY_SMART_ENABLE_LEVEL_64" + ] + } + } + }, + "end_device_controlled": { + "type": "object" + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "serving_device_id": { + "description": "End device identifier of the serving end device.", + "type": "string" + } + } + }, + "serving": { + "type": "object", + "properties": { + "cad_periodicity": { + "type": "string", + "title": "- RELAY_CAD_PERIODICITY_20_MILLISECONDS: sic", + "default": "RELAY_CAD_PERIODICITY_1_SECOND", + "enum": [ + "RELAY_CAD_PERIODICITY_1_SECOND", + "RELAY_CAD_PERIODICITY_500_MILLISECONDS", + "RELAY_CAD_PERIODICITY_250_MILLISECONDS", + "RELAY_CAD_PERIODICITY_100_MILLISECONDS", + "RELAY_CAD_PERIODICITY_50_MILLISECONDS", + "RELAY_CAD_PERIODICITY_20_MILLISECONDS" + ] + }, + "default_channel_index": { + "description": "Index of the default wake on radio channel.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "join_requests": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "notifications": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "overall": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "reset_behavior": { + "type": "string", + "default": "RELAY_RESET_LIMIT_COUNTER_ZERO", + "enum": [ + "RELAY_RESET_LIMIT_COUNTER_ZERO", + "RELAY_RESET_LIMIT_COUNTER_RELOAD_RATE", + "RELAY_RESET_LIMIT_COUNTER_MAX_VALUE", + "RELAY_RESET_LIMIT_COUNTER_NO_RESET" + ] + }, + "uplink_messages": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + } + } + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "uplink_forwarding_rules": { + "description": "Configured uplink forwarding rules.", + "type": "array", + "items": { + "type": "object", + "properties": { + "device_id": { + "description": "End device identifier of the served end device.", + "type": "string" + }, + "last_w_f_cnt": { + "description": "Last wake on radio frame counter used by the served end device.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "session_key_id": { + "description": "Session key ID of the session keys used to derive the root relay session key.", + "type": "string", + "format": "byte" + } + } + } + } + } + } + } + }, + "resets_f_cnt": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "rx1_data_rate_offset": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_OFFSET_0", + "enum": [ + "DATA_RATE_OFFSET_0", + "DATA_RATE_OFFSET_1", + "DATA_RATE_OFFSET_2", + "DATA_RATE_OFFSET_3", + "DATA_RATE_OFFSET_4", + "DATA_RATE_OFFSET_5", + "DATA_RATE_OFFSET_6", + "DATA_RATE_OFFSET_7" + ] + } + } + }, + "rx1_delay": { + "type": "object", + "properties": { + "value": { + "description": " - RX_DELAY_0: 1 second.\n - RX_DELAY_1: 1 second.\n - RX_DELAY_2: 2 seconds.\n - RX_DELAY_3: 3 seconds.\n - RX_DELAY_4: 4 seconds.\n - RX_DELAY_5: 5 seconds.\n - RX_DELAY_6: 6 seconds.\n - RX_DELAY_7: 7 seconds.\n - RX_DELAY_8: 8 seconds.\n - RX_DELAY_9: 9 seconds.\n - RX_DELAY_10: 10 seconds.\n - RX_DELAY_11: 11 seconds.\n - RX_DELAY_12: 12 seconds.\n - RX_DELAY_13: 13 seconds.\n - RX_DELAY_14: 14 seconds.\n - RX_DELAY_15: 15 seconds.", + "type": "string", + "default": "RX_DELAY_0", + "enum": [ + "RX_DELAY_0", + "RX_DELAY_1", + "RX_DELAY_2", + "RX_DELAY_3", + "RX_DELAY_4", + "RX_DELAY_5", + "RX_DELAY_6", + "RX_DELAY_7", + "RX_DELAY_8", + "RX_DELAY_9", + "RX_DELAY_10", + "RX_DELAY_11", + "RX_DELAY_12", + "RX_DELAY_13", + "RX_DELAY_14", + "RX_DELAY_15" + ] + } + } + }, + "rx2_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "rx2_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "schedule_downlinks": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "status_count_periodicity": { + "description": "Number of uplink messages after which a DevStatusReq MACCommand shall be sent.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "status_time_periodicity": { + "description": "The interval after which a DevStatusReq MACCommand shall be sent.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "supports_32_bit_f_cnt": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "uplink_dwell_time": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "use_adr": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + } + } + } + } + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "details": { + "type": "array", + "items": { + "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }", + "type": "object", + "properties": { + "@type": { + "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.", + "type": "string" + } + }, + "additionalProperties": {} + } + }, + "message": { + "type": "string" + } + } + } + } + } + }, + "delete": { + "tags": [ + "NsMACSettingsProfileRegistry" + ], + "summary": "Delete deletes the MAC settings profile that matches the given identifiers.", + "operationId": "NsMACSettingsProfileRegistry_Delete", + "parameters": [ + { + "type": "string", + "name": "mac_settings_profile_ids.application_ids.application_id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "Profile ID.", + "name": "mac_settings_profile_ids.profile_id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "type": "object" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "details": { + "type": "array", + "items": { + "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }", + "type": "object", + "properties": { + "@type": { + "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.", + "type": "string" + } + }, + "additionalProperties": {} + } + }, + "message": { + "type": "string" + } + } + } + } + } + } + }, + "/ns/default_mac_settings/{frequency_plan_id}/{lorawan_phy_version}": { + "get": { + "tags": [ + "Ns" + ], + "summary": "GetDefaultMACSettings retrieves the default MAC settings for a frequency plan.", + "operationId": "Ns_GetDefaultMACSettings", + "parameters": [ + { + "type": "string", + "name": "frequency_plan_id", + "in": "path", + "required": true + }, + { + "enum": [ + "PHY_UNKNOWN", + "PHY_V1_0", + "TS001_V1_0", + "PHY_V1_0_1", + "TS001_V1_0_1", + "PHY_V1_0_2_REV_A", + "RP001_V1_0_2", + "PHY_V1_0_2_REV_B", + "RP001_V1_0_2_REV_B", + "PHY_V1_1_REV_A", + "RP001_V1_1_REV_A", + "PHY_V1_1_REV_B", + "RP001_V1_1_REV_B", + "PHY_V1_0_3_REV_A", + "RP001_V1_0_3_REV_A", + "RP002_V1_0_0", + "RP002_V1_0_1", + "RP002_V1_0_2", + "RP002_V1_0_3", + "RP002_V1_0_4" + ], + "type": "string", + "name": "lorawan_phy_version", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "type": "object", + "properties": { + "adr": { + "description": "Adaptive Data Rate settings.", + "type": "object", + "properties": { + "disabled": { + "description": "Configuration options for cases in which ADR is to be disabled\ncompletely.", + "type": "object" + }, + "dynamic": { + "description": "Configuration options for dynamic ADR.", + "type": "object", + "properties": { + "channel_steering": { + "description": "EXPERIMENTAL: Channel steering settings.", + "type": "object", + "properties": { + "disabled": { + "description": "Configuration options for cases in which ADR is not supposed to steer the end device\nto another set of channels.", + "type": "object" + }, + "lora_narrow": { + "description": "Configuration options for LoRa narrow channels steering.\nThe narrow mode attempts to steer the end device towards\nusing the LoRa modulated, 125kHz bandwidth channels.", + "type": "object" + } + } + }, + "margin": { + "description": "The ADR margin (dB) tells the network server how much margin it should add in ADR requests.\nA bigger margin is less efficient, but gives a better chance of successful reception.\nIf unset, the default value from Network Server configuration will be used.", + "type": "number", + "format": "float" + }, + "max_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "max_tx_power_index": { + "description": "Maximum transmission power index.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_tx_power_index": { + "description": "Minimum transmission power index.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "overrides": { + "description": "EXPERIMENTAL: Configuration overrides.", + "type": "object", + "properties": { + "data_rate_0": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_1": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_10": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_11": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_12": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_13": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_14": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_15": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_2": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_3": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_4": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_5": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_6": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_7": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_8": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_9": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + } + } + } + } + }, + "static": { + "description": "Configuration options for static ADR.", + "type": "object", + "properties": { + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "nb_trans": { + "description": "Number of retransmissions.", + "type": "integer", + "format": "int64" + }, + "tx_power_index": { + "description": "Transmission power index to use.", + "type": "integer", + "format": "int64" + } + } + } + } + }, + "adr_margin": { + "description": "The ADR margin (dB) tells the network server how much margin it should add in ADR requests.\nA bigger margin is less efficient, but gives a better chance of successful reception.\nThis field is deprecated, use adr_settings.dynamic.margin instead.", + "type": "number", + "format": "float" + }, + "beacon_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "class_b_c_downlink_interval": { + "description": "The minimum duration passed before a network-initiated(e.g. Class B or C) downlink following an arbitrary downlink.", + "type": "string" + }, + "class_b_timeout": { + "description": "Maximum delay for the device to answer a MAC request or a confirmed downlink frame.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "class_c_timeout": { + "description": "Maximum delay for the device to answer a MAC request or a confirmed downlink frame.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "desired_adr_ack_delay_exponent": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "ADR_ACK_DELAY_1", + "enum": [ + "ADR_ACK_DELAY_1", + "ADR_ACK_DELAY_2", + "ADR_ACK_DELAY_4", + "ADR_ACK_DELAY_8", + "ADR_ACK_DELAY_16", + "ADR_ACK_DELAY_32", + "ADR_ACK_DELAY_64", + "ADR_ACK_DELAY_128", + "ADR_ACK_DELAY_256", + "ADR_ACK_DELAY_512", + "ADR_ACK_DELAY_1024", + "ADR_ACK_DELAY_2048", + "ADR_ACK_DELAY_4096", + "ADR_ACK_DELAY_8192", + "ADR_ACK_DELAY_16384", + "ADR_ACK_DELAY_32768" + ] + } + } + }, + "desired_adr_ack_limit_exponent": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "ADR_ACK_LIMIT_1", + "enum": [ + "ADR_ACK_LIMIT_1", + "ADR_ACK_LIMIT_2", + "ADR_ACK_LIMIT_4", + "ADR_ACK_LIMIT_8", + "ADR_ACK_LIMIT_16", + "ADR_ACK_LIMIT_32", + "ADR_ACK_LIMIT_64", + "ADR_ACK_LIMIT_128", + "ADR_ACK_LIMIT_256", + "ADR_ACK_LIMIT_512", + "ADR_ACK_LIMIT_1024", + "ADR_ACK_LIMIT_2048", + "ADR_ACK_LIMIT_4096", + "ADR_ACK_LIMIT_8192", + "ADR_ACK_LIMIT_16384", + "ADR_ACK_LIMIT_32768" + ] + } + } + }, + "desired_beacon_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "desired_max_duty_cycle": { + "type": "object", + "properties": { + "value": { + "description": " - DUTY_CYCLE_1: 100%.\n - DUTY_CYCLE_2: 50%.\n - DUTY_CYCLE_4: 25%.\n - DUTY_CYCLE_8: 12.5%.\n - DUTY_CYCLE_16: 6.25%.\n - DUTY_CYCLE_32: 3.125%.\n - DUTY_CYCLE_64: 1.5625%.\n - DUTY_CYCLE_128: Roughly 0.781%.\n - DUTY_CYCLE_256: Roughly 0.390%.\n - DUTY_CYCLE_512: Roughly 0.195%.\n - DUTY_CYCLE_1024: Roughly 0.098%.\n - DUTY_CYCLE_2048: Roughly 0.049%.\n - DUTY_CYCLE_4096: Roughly 0.024%.\n - DUTY_CYCLE_8192: Roughly 0.012%.\n - DUTY_CYCLE_16384: Roughly 0.006%.\n - DUTY_CYCLE_32768: Roughly 0.003%.", + "type": "string", + "default": "DUTY_CYCLE_1", + "enum": [ + "DUTY_CYCLE_1", + "DUTY_CYCLE_2", + "DUTY_CYCLE_4", + "DUTY_CYCLE_8", + "DUTY_CYCLE_16", + "DUTY_CYCLE_32", + "DUTY_CYCLE_64", + "DUTY_CYCLE_128", + "DUTY_CYCLE_256", + "DUTY_CYCLE_512", + "DUTY_CYCLE_1024", + "DUTY_CYCLE_2048", + "DUTY_CYCLE_4096", + "DUTY_CYCLE_8192", + "DUTY_CYCLE_16384", + "DUTY_CYCLE_32768" + ] + } + } + }, + "desired_max_eirp": { + "type": "object", + "properties": { + "value": { + "description": " - DEVICE_EIRP_8: 8 dBm.\n - DEVICE_EIRP_10: 10 dBm.\n - DEVICE_EIRP_12: 12 dBm.\n - DEVICE_EIRP_13: 13 dBm.\n - DEVICE_EIRP_14: 14 dBm.\n - DEVICE_EIRP_16: 16 dBm.\n - DEVICE_EIRP_18: 18 dBm.\n - DEVICE_EIRP_20: 20 dBm.\n - DEVICE_EIRP_21: 21 dBm.\n - DEVICE_EIRP_24: 24 dBm.\n - DEVICE_EIRP_26: 26 dBm.\n - DEVICE_EIRP_27: 27 dBm.\n - DEVICE_EIRP_29: 29 dBm.\n - DEVICE_EIRP_30: 30 dBm.\n - DEVICE_EIRP_33: 33 dBm.\n - DEVICE_EIRP_36: 36 dBm.", + "type": "string", + "default": "DEVICE_EIRP_8", + "enum": [ + "DEVICE_EIRP_8", + "DEVICE_EIRP_10", + "DEVICE_EIRP_12", + "DEVICE_EIRP_13", + "DEVICE_EIRP_14", + "DEVICE_EIRP_16", + "DEVICE_EIRP_18", + "DEVICE_EIRP_20", + "DEVICE_EIRP_21", + "DEVICE_EIRP_24", + "DEVICE_EIRP_26", + "DEVICE_EIRP_27", + "DEVICE_EIRP_29", + "DEVICE_EIRP_30", + "DEVICE_EIRP_33", + "DEVICE_EIRP_36" + ] + } + } + }, + "desired_ping_slot_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "desired_ping_slot_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "desired_relay": { + "description": "RelaySettings represent the settings of a relay.\nThis is used internally by the Network Server.", + "type": "object", + "properties": { + "served": { + "type": "object", + "properties": { + "always": { + "type": "object" + }, + "backoff": { + "description": "Number of wake on radio frames to be sent without an acknowledgement before sending the uplink message directly.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "dynamic": { + "type": "object", + "properties": { + "smart_enable_level": { + "type": "string", + "default": "RELAY_SMART_ENABLE_LEVEL_8", + "enum": [ + "RELAY_SMART_ENABLE_LEVEL_8", + "RELAY_SMART_ENABLE_LEVEL_16", + "RELAY_SMART_ENABLE_LEVEL_32", + "RELAY_SMART_ENABLE_LEVEL_64" + ] + } + } + }, + "end_device_controlled": { + "type": "object" + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "serving_device_id": { + "description": "End device identifier of the serving end device.", + "type": "string" + } + } + }, + "serving": { + "type": "object", + "properties": { + "cad_periodicity": { + "type": "string", + "title": "- RELAY_CAD_PERIODICITY_20_MILLISECONDS: sic", + "default": "RELAY_CAD_PERIODICITY_1_SECOND", + "enum": [ + "RELAY_CAD_PERIODICITY_1_SECOND", + "RELAY_CAD_PERIODICITY_500_MILLISECONDS", + "RELAY_CAD_PERIODICITY_250_MILLISECONDS", + "RELAY_CAD_PERIODICITY_100_MILLISECONDS", + "RELAY_CAD_PERIODICITY_50_MILLISECONDS", + "RELAY_CAD_PERIODICITY_20_MILLISECONDS" + ] + }, + "default_channel_index": { + "description": "Index of the default wake on radio channel.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "join_requests": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "notifications": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "overall": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "reset_behavior": { + "type": "string", + "default": "RELAY_RESET_LIMIT_COUNTER_ZERO", + "enum": [ + "RELAY_RESET_LIMIT_COUNTER_ZERO", + "RELAY_RESET_LIMIT_COUNTER_RELOAD_RATE", + "RELAY_RESET_LIMIT_COUNTER_MAX_VALUE", + "RELAY_RESET_LIMIT_COUNTER_NO_RESET" + ] + }, + "uplink_messages": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + } + } + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "uplink_forwarding_rules": { + "description": "Configured uplink forwarding rules.", + "type": "array", + "items": { + "type": "object", + "properties": { + "device_id": { + "description": "End device identifier of the served end device.", + "type": "string" + }, + "last_w_f_cnt": { + "description": "Last wake on radio frame counter used by the served end device.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "session_key_id": { + "description": "Session key ID of the session keys used to derive the root relay session key.", + "type": "string", + "format": "byte" + } + } + } + } + } + } + } + }, + "desired_rx1_data_rate_offset": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_OFFSET_0", + "enum": [ + "DATA_RATE_OFFSET_0", + "DATA_RATE_OFFSET_1", + "DATA_RATE_OFFSET_2", + "DATA_RATE_OFFSET_3", + "DATA_RATE_OFFSET_4", + "DATA_RATE_OFFSET_5", + "DATA_RATE_OFFSET_6", + "DATA_RATE_OFFSET_7" + ] + } + } + }, + "desired_rx1_delay": { + "type": "object", + "properties": { + "value": { + "description": " - RX_DELAY_0: 1 second.\n - RX_DELAY_1: 1 second.\n - RX_DELAY_2: 2 seconds.\n - RX_DELAY_3: 3 seconds.\n - RX_DELAY_4: 4 seconds.\n - RX_DELAY_5: 5 seconds.\n - RX_DELAY_6: 6 seconds.\n - RX_DELAY_7: 7 seconds.\n - RX_DELAY_8: 8 seconds.\n - RX_DELAY_9: 9 seconds.\n - RX_DELAY_10: 10 seconds.\n - RX_DELAY_11: 11 seconds.\n - RX_DELAY_12: 12 seconds.\n - RX_DELAY_13: 13 seconds.\n - RX_DELAY_14: 14 seconds.\n - RX_DELAY_15: 15 seconds.", + "type": "string", + "default": "RX_DELAY_0", + "enum": [ + "RX_DELAY_0", + "RX_DELAY_1", + "RX_DELAY_2", + "RX_DELAY_3", + "RX_DELAY_4", + "RX_DELAY_5", + "RX_DELAY_6", + "RX_DELAY_7", + "RX_DELAY_8", + "RX_DELAY_9", + "RX_DELAY_10", + "RX_DELAY_11", + "RX_DELAY_12", + "RX_DELAY_13", + "RX_DELAY_14", + "RX_DELAY_15" + ] + } + } + }, + "desired_rx2_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "desired_rx2_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "downlink_dwell_time": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "factory_preset_frequencies": { + "description": "List of factory-preset frequencies.\nIf unset, the default value from Network Server configuration or regional parameters specification will be used.", + "type": "array", + "items": { + "type": "string", + "format": "uint64" + } + }, + "max_duty_cycle": { + "type": "object", + "properties": { + "value": { + "description": " - DUTY_CYCLE_1: 100%.\n - DUTY_CYCLE_2: 50%.\n - DUTY_CYCLE_4: 25%.\n - DUTY_CYCLE_8: 12.5%.\n - DUTY_CYCLE_16: 6.25%.\n - DUTY_CYCLE_32: 3.125%.\n - DUTY_CYCLE_64: 1.5625%.\n - DUTY_CYCLE_128: Roughly 0.781%.\n - DUTY_CYCLE_256: Roughly 0.390%.\n - DUTY_CYCLE_512: Roughly 0.195%.\n - DUTY_CYCLE_1024: Roughly 0.098%.\n - DUTY_CYCLE_2048: Roughly 0.049%.\n - DUTY_CYCLE_4096: Roughly 0.024%.\n - DUTY_CYCLE_8192: Roughly 0.012%.\n - DUTY_CYCLE_16384: Roughly 0.006%.\n - DUTY_CYCLE_32768: Roughly 0.003%.", + "type": "string", + "default": "DUTY_CYCLE_1", + "enum": [ + "DUTY_CYCLE_1", + "DUTY_CYCLE_2", + "DUTY_CYCLE_4", + "DUTY_CYCLE_8", + "DUTY_CYCLE_16", + "DUTY_CYCLE_32", + "DUTY_CYCLE_64", + "DUTY_CYCLE_128", + "DUTY_CYCLE_256", + "DUTY_CYCLE_512", + "DUTY_CYCLE_1024", + "DUTY_CYCLE_2048", + "DUTY_CYCLE_4096", + "DUTY_CYCLE_8192", + "DUTY_CYCLE_16384", + "DUTY_CYCLE_32768" + ] + } + } + }, + "ping_slot_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "ping_slot_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "ping_slot_periodicity": { + "type": "object", + "properties": { + "value": { + "description": " - PING_EVERY_1S: Every second.\n - PING_EVERY_2S: Every 2 seconds.\n - PING_EVERY_4S: Every 4 seconds.\n - PING_EVERY_8S: Every 8 seconds.\n - PING_EVERY_16S: Every 16 seconds.\n - PING_EVERY_32S: Every 32 seconds.\n - PING_EVERY_64S: Every 64 seconds.\n - PING_EVERY_128S: Every 128 seconds.", + "type": "string", + "default": "PING_EVERY_1S", + "enum": [ + "PING_EVERY_1S", + "PING_EVERY_2S", + "PING_EVERY_4S", + "PING_EVERY_8S", + "PING_EVERY_16S", + "PING_EVERY_32S", + "PING_EVERY_64S", + "PING_EVERY_128S" + ] + } + } + }, + "relay": { + "description": "RelaySettings represent the settings of a relay.\nThis is used internally by the Network Server.", + "type": "object", + "properties": { + "served": { + "type": "object", + "properties": { + "always": { + "type": "object" + }, + "backoff": { + "description": "Number of wake on radio frames to be sent without an acknowledgement before sending the uplink message directly.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "dynamic": { + "type": "object", + "properties": { + "smart_enable_level": { + "type": "string", + "default": "RELAY_SMART_ENABLE_LEVEL_8", + "enum": [ + "RELAY_SMART_ENABLE_LEVEL_8", + "RELAY_SMART_ENABLE_LEVEL_16", + "RELAY_SMART_ENABLE_LEVEL_32", + "RELAY_SMART_ENABLE_LEVEL_64" + ] + } + } + }, + "end_device_controlled": { + "type": "object" + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "serving_device_id": { + "description": "End device identifier of the serving end device.", + "type": "string" + } + } + }, + "serving": { + "type": "object", + "properties": { + "cad_periodicity": { + "type": "string", + "title": "- RELAY_CAD_PERIODICITY_20_MILLISECONDS: sic", + "default": "RELAY_CAD_PERIODICITY_1_SECOND", + "enum": [ + "RELAY_CAD_PERIODICITY_1_SECOND", + "RELAY_CAD_PERIODICITY_500_MILLISECONDS", + "RELAY_CAD_PERIODICITY_250_MILLISECONDS", + "RELAY_CAD_PERIODICITY_100_MILLISECONDS", + "RELAY_CAD_PERIODICITY_50_MILLISECONDS", + "RELAY_CAD_PERIODICITY_20_MILLISECONDS" + ] + }, + "default_channel_index": { + "description": "Index of the default wake on radio channel.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "join_requests": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "notifications": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "overall": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "reset_behavior": { + "type": "string", + "default": "RELAY_RESET_LIMIT_COUNTER_ZERO", + "enum": [ + "RELAY_RESET_LIMIT_COUNTER_ZERO", + "RELAY_RESET_LIMIT_COUNTER_RELOAD_RATE", + "RELAY_RESET_LIMIT_COUNTER_MAX_VALUE", + "RELAY_RESET_LIMIT_COUNTER_NO_RESET" + ] + }, + "uplink_messages": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + } + } + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "uplink_forwarding_rules": { + "description": "Configured uplink forwarding rules.", + "type": "array", + "items": { + "type": "object", + "properties": { + "device_id": { + "description": "End device identifier of the served end device.", + "type": "string" + }, + "last_w_f_cnt": { + "description": "Last wake on radio frame counter used by the served end device.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "session_key_id": { + "description": "Session key ID of the session keys used to derive the root relay session key.", + "type": "string", + "format": "byte" + } + } + } + } + } + } + } + }, + "resets_f_cnt": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "rx1_data_rate_offset": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_OFFSET_0", + "enum": [ + "DATA_RATE_OFFSET_0", + "DATA_RATE_OFFSET_1", + "DATA_RATE_OFFSET_2", + "DATA_RATE_OFFSET_3", + "DATA_RATE_OFFSET_4", + "DATA_RATE_OFFSET_5", + "DATA_RATE_OFFSET_6", + "DATA_RATE_OFFSET_7" + ] + } + } + }, + "rx1_delay": { + "type": "object", + "properties": { + "value": { + "description": " - RX_DELAY_0: 1 second.\n - RX_DELAY_1: 1 second.\n - RX_DELAY_2: 2 seconds.\n - RX_DELAY_3: 3 seconds.\n - RX_DELAY_4: 4 seconds.\n - RX_DELAY_5: 5 seconds.\n - RX_DELAY_6: 6 seconds.\n - RX_DELAY_7: 7 seconds.\n - RX_DELAY_8: 8 seconds.\n - RX_DELAY_9: 9 seconds.\n - RX_DELAY_10: 10 seconds.\n - RX_DELAY_11: 11 seconds.\n - RX_DELAY_12: 12 seconds.\n - RX_DELAY_13: 13 seconds.\n - RX_DELAY_14: 14 seconds.\n - RX_DELAY_15: 15 seconds.", + "type": "string", + "default": "RX_DELAY_0", + "enum": [ + "RX_DELAY_0", + "RX_DELAY_1", + "RX_DELAY_2", + "RX_DELAY_3", + "RX_DELAY_4", + "RX_DELAY_5", + "RX_DELAY_6", + "RX_DELAY_7", + "RX_DELAY_8", + "RX_DELAY_9", + "RX_DELAY_10", + "RX_DELAY_11", + "RX_DELAY_12", + "RX_DELAY_13", + "RX_DELAY_14", + "RX_DELAY_15" + ] + } + } + }, + "rx2_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "rx2_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "schedule_downlinks": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "status_count_periodicity": { + "description": "Number of uplink messages after which a DevStatusReq MACCommand shall be sent.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "status_time_periodicity": { + "description": "The interval after which a DevStatusReq MACCommand shall be sent.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "supports_32_bit_f_cnt": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "uplink_dwell_time": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "use_adr": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "details": { + "type": "array", + "items": { + "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }", + "type": "object", + "properties": { + "@type": { + "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.", + "type": "string" + } + }, + "additionalProperties": {} + } + }, + "message": { + "type": "string" + } + } + } + } + } + } + }, + "/ns/dev_addr": { + "get": { + "tags": [ + "Ns" + ], + "summary": "GenerateDevAddr requests a device address assignment from the Network Server.", + "operationId": "Ns_GenerateDevAddr", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "description": "Response of GenerateDevAddr.", + "type": "object", + "properties": { + "dev_addr": { + "type": "string", + "format": "string", + "example": "2600ABCD" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "details": { + "type": "array", + "items": { + "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }", + "type": "object", + "properties": { + "@type": { + "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.", + "type": "string" + } + }, + "additionalProperties": {} + } + }, + "message": { + "type": "string" + } + } + } + } + } + } + }, + "/ns/dev_addr_prefixes": { + "get": { + "tags": [ + "Ns" + ], + "operationId": "Ns_GetDeviceAddressPrefixes", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "type": "object", + "properties": { + "dev_addr_prefixes": { + "type": "array", + "items": { + "type": "string", + "format": "byte" + }, + "example": [ + "2600AB00/24" + ] + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "details": { + "type": "array", + "items": { + "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }", + "type": "object", + "properties": { + "@type": { + "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.", + "type": "string" + } + }, + "additionalProperties": {} + } + }, + "message": { + "type": "string" + } + } + } + } + } + } + }, + "/ns/net_id": { + "get": { + "tags": [ + "Ns" + ], + "operationId": "Ns_GetNetID", + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "type": "object", + "properties": { + "net_id": { + "type": "string", + "format": "string", + "example": "000013" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "details": { + "type": "array", + "items": { + "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }", + "type": "object", + "properties": { + "@type": { + "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.", + "type": "string" + } + }, + "additionalProperties": {} + } + }, + "message": { + "type": "string" + } + } + } + } + } + } + }, + "/organizations": { + "get": { + "description": "If no user or organization is given, this returns the organizations the caller\nhas access to.\nSimilar to Get, this selects the fields given by the field mask.\nMore or less fields may be returned, depending on the rights of the caller.", + "tags": [ + "OrganizationRegistry" + ], + "summary": "List organizations where the given user or organization is a direct collaborator.", + "operationId": "OrganizationRegistry_List", + "parameters": [ + { + "type": "string", + "description": "This ID shares namespace with user IDs.", + "name": "collaborator.organization_ids.organization_id", + "in": "query" + }, + { + "type": "string", + "description": "This ID shares namespace with organization IDs.", + "name": "collaborator.user_ids.user_id", + "in": "query" + }, + { + "type": "string", + "description": "Secondary identifier, which can only be used in specific requests.", + "name": "collaborator.user_ids.email", + "in": "query" + }, + { + "type": "string", + "description": "The names of the organization fields that should be returned.", + "name": "field_mask", + "in": "query" + }, + { + "type": "string", + "description": "Order the results by this field path (must be present in the field mask).\nDefault ordering is by ID. Prepend with a minus (-) to reverse the order.", + "name": "order", + "in": "query" + }, + { + "type": "integer", + "format": "int64", + "description": "Limit the number of results per page.", + "name": "limit", + "in": "query" + }, + { + "type": "integer", + "format": "int64", + "description": "Page number for pagination. 0 is interpreted as 1.", + "name": "page", + "in": "query" + }, + { + "type": "boolean", + "description": "Only return recently deleted organizations.", + "name": "deleted", + "in": "query" + } + ], + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "type": "object", + "properties": { + "organizations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "administrative_contact": { + "description": "OrganizationOrUserIdentifiers contains either organization or user identifiers.", + "type": "object", + "properties": { + "organization_ids": { + "type": "object", + "properties": { + "organization_id": { + "description": "This ID shares namespace with user IDs.", + "type": "string" + } + } + }, + "user_ids": { + "type": "object", + "properties": { + "email": { + "description": "Secondary identifier, which can only be used in specific requests.", + "type": "string" + }, + "user_id": { + "description": "This ID shares namespace with organization IDs.", + "type": "string" + } + } + } + } + }, + "application_limit": { + "description": "The maximum number of applications of the organization.\nThis field can only be modified by admins.", + "type": "string", + "format": "uint64" + }, + "attributes": { + "description": "Key-value attributes for this organization. Typically used for organizing organizations or for storing integration-specific data.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "client_limit": { + "description": "The maximum number of clients of the organization.\nThis field can only be modified by admins.", + "type": "string", + "format": "uint64" + }, + "contact_info": { + "description": "Contact information for this organization. Typically used to indicate who to contact with security/billing questions about the organization.\nThis field is deprecated. Use administrative_contact and technical_contact instead.", + "type": "array", + "items": { + "type": "object", + "properties": { + "contact_method": { + "type": "string", + "default": "CONTACT_METHOD_OTHER", + "enum": [ + "CONTACT_METHOD_OTHER", + "CONTACT_METHOD_EMAIL", + "CONTACT_METHOD_PHONE" + ] + }, + "contact_type": { + "type": "string", + "default": "CONTACT_TYPE_OTHER", + "enum": [ + "CONTACT_TYPE_OTHER", + "CONTACT_TYPE_ABUSE", + "CONTACT_TYPE_BILLING", + "CONTACT_TYPE_TECHNICAL" + ] + }, + "public": { + "type": "boolean" + }, + "validated_at": { + "type": "string", + "format": "date-time" + }, + "value": { + "type": "string" + } + } + } + }, + "created_at": { + "description": "When the organization was created. This information is public and can be seen by any authenticated user in the network.", + "type": "string", + "format": "date-time" + }, + "deleted_at": { + "description": "When the organization was deleted. This information is public and can be seen by any authenticated user in the network.", + "type": "string", + "format": "date-time" + }, + "description": { + "description": "A description for the organization.", + "type": "string" + }, + "fanout_notifications": { + "description": "Determines if a notification will be sent to the collaborators. If false it, notifications will be sent only to the\nadministrative or technical contact.", + "type": "boolean" + }, + "gateway_limit": { + "description": "The maximum number of gateways of the organization.\nThis field can only be modified by admins.", + "type": "string", + "format": "uint64" + }, + "ids": { + "type": "object", + "properties": { + "organization_id": { + "description": "This ID shares namespace with user IDs.", + "type": "string" + } + } + }, + "name": { + "description": "The name of the organization. This information is public and can be seen by any authenticated user in the network.", + "type": "string" + }, + "technical_contact": { + "description": "OrganizationOrUserIdentifiers contains either organization or user identifiers.", + "type": "object", + "properties": { + "organization_ids": { + "type": "object", + "properties": { + "organization_id": { + "description": "This ID shares namespace with user IDs.", + "type": "string" + } + } + }, + "user_ids": { + "type": "object", + "properties": { + "email": { + "description": "Secondary identifier, which can only be used in specific requests.", + "type": "string" + }, + "user_id": { + "description": "This ID shares namespace with organization IDs.", + "type": "string" + } + } + } + } + }, + "updated_at": { + "description": "When the organization was last updated. This information is public and can be seen by any authenticated user in the network.", + "type": "string", + "format": "date-time" + } + } + } + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "details": { + "type": "array", + "items": { + "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }", + "type": "object", + "properties": { + "@type": { + "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.", + "type": "string" + } + }, + "additionalProperties": {} + } + }, + "message": { + "type": "string" + } + } + } + } + } + } + }, + "/organizations/{collaborator.organization_ids.organization_id}/applications": { + "get": { + "description": "If no user or organization is given, this returns the applications the caller\nhas access to.\nSimilar to Get, this selects the fields given by the field mask.\nMore or less fields may be returned, depending on the rights of the caller.", + "tags": [ + "ApplicationRegistry" + ], + "summary": "List applications where the given user or organization is a direct collaborator.", + "operationId": "ApplicationRegistry_List3", + "parameters": [ + { + "type": "string", + "description": "This ID shares namespace with user IDs.", + "name": "collaborator.organization_ids.organization_id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "This ID shares namespace with organization IDs.", + "name": "collaborator.user_ids.user_id", + "in": "query" + }, + { + "type": "string", + "description": "Secondary identifier, which can only be used in specific requests.", + "name": "collaborator.user_ids.email", + "in": "query" + }, + { + "type": "string", + "description": "The names of the application fields that should be returned.", + "name": "field_mask", + "in": "query" + }, + { + "type": "string", + "description": "Order the results by this field path (must be present in the field mask).\nDefault ordering is by ID. Prepend with a minus (-) to reverse the order.", + "name": "order", + "in": "query" + }, + { + "type": "integer", + "format": "int64", + "description": "Limit the number of results per page.", + "name": "limit", + "in": "query" + }, + { + "type": "integer", + "format": "int64", + "description": "Page number for pagination. 0 is interpreted as 1.", + "name": "page", + "in": "query" + }, + { + "type": "boolean", + "description": "Only return recently deleted applications.", + "name": "deleted", + "in": "query" + } + ], + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "type": "object", + "properties": { + "applications": { + "type": "array", + "items": { + "description": "Application is the message that defines an Application in the network.", + "type": "object", + "properties": { + "administrative_contact": { + "description": "OrganizationOrUserIdentifiers contains either organization or user identifiers.", + "type": "object", + "properties": { + "organization_ids": { + "type": "object", + "properties": { + "organization_id": { + "description": "This ID shares namespace with user IDs.", + "type": "string" + } + } + }, + "user_ids": { + "type": "object", + "properties": { + "email": { + "description": "Secondary identifier, which can only be used in specific requests.", + "type": "string" + }, + "user_id": { + "description": "This ID shares namespace with organization IDs.", + "type": "string" + } + } + } + } + }, + "application_server_address": { + "description": "The address of the Application Server where this application is supposed to be registered.\nIf set, this fields indicates where end devices for this application should be registered.\n\nStored in Entity Registry.\nThe typical format of the address is \"host:port\". If the port is omitted,\nthe normal port inference (with DNS lookup, otherwise defaults) is used.\nThe connection shall be established with transport layer security (TLS).\nCustom certificate authorities may be configured out-of-band.", + "type": "string" + }, + "attributes": { + "description": "Key-value attributes for this application. Typically used for organizing applications or for storing integration-specific data.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "contact_info": { + "description": "Contact information for this application. Typically used to indicate who to contact with technical/security questions about the application.\nThis field is deprecated. Use administrative_contact and technical_contact instead.", + "type": "array", + "items": { + "type": "object", + "properties": { + "contact_method": { + "type": "string", + "default": "CONTACT_METHOD_OTHER", + "enum": [ + "CONTACT_METHOD_OTHER", + "CONTACT_METHOD_EMAIL", + "CONTACT_METHOD_PHONE" + ] + }, + "contact_type": { + "type": "string", + "default": "CONTACT_TYPE_OTHER", + "enum": [ + "CONTACT_TYPE_OTHER", + "CONTACT_TYPE_ABUSE", + "CONTACT_TYPE_BILLING", + "CONTACT_TYPE_TECHNICAL" + ] + }, + "public": { + "type": "boolean" + }, + "validated_at": { + "type": "string", + "format": "date-time" + }, + "value": { + "type": "string" + } + } + } + }, + "created_at": { + "description": "When the application was created. This information is public and can be seen by any authenticated user in the network.", + "type": "string", + "format": "date-time" + }, + "deleted_at": { + "description": "When the application was deleted. This information is public and can be seen by any authenticated user in the network.", + "type": "string", + "format": "date-time" + }, + "description": { + "description": "A description for the application.", + "type": "string" + }, + "dev_eui_counter": { + "type": "integer", + "format": "int64" + }, + "end_device_limit": { + "description": "The limit of the number of end devices that can be registered for this application.\nThis field can only be modified by admins.", + "type": "string", + "format": "uint64" + }, + "ids": { + "type": "object", + "properties": { + "application_id": { + "type": "string" + } + } + }, + "join_server_address": { + "description": "The address of the Join Server where this application is supposed to be registered.\nIf set, this fields indicates where end devices for this application should be registered.\n\nStored in Entity Registry.\nThe typical format of the address is \"host:port\". If the port is omitted,\nthe normal port inference (with DNS lookup, otherwise defaults) is used.\nThe connection shall be established with transport layer security (TLS).\nCustom certificate authorities may be configured out-of-band.", + "type": "string" + }, + "name": { + "description": "The name of the application.", + "type": "string" + }, + "network_server_address": { + "description": "The address of the Network Server where this application is supposed to be registered.\nIf set, this fields indicates where end devices for this application should be registered.\n\nStored in Entity Registry.\nThe typical format of the address is \"host:port\". If the port is omitted,\nthe normal port inference (with DNS lookup, otherwise defaults) is used.\nThe connection shall be established with transport layer security (TLS).\nCustom certificate authorities may be configured out-of-band.", + "type": "string" + }, + "technical_contact": { + "description": "OrganizationOrUserIdentifiers contains either organization or user identifiers.", + "type": "object", + "properties": { + "organization_ids": { + "type": "object", + "properties": { + "organization_id": { + "description": "This ID shares namespace with user IDs.", + "type": "string" + } + } + }, + "user_ids": { + "type": "object", + "properties": { + "email": { + "description": "Secondary identifier, which can only be used in specific requests.", + "type": "string" + }, + "user_id": { + "description": "This ID shares namespace with organization IDs.", + "type": "string" + } + } + } + } + }, + "updated_at": { + "description": "When the application was last updated. This information is public and can be seen by any authenticated user in the network.", + "type": "string", + "format": "date-time" + } + } + } + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "details": { + "type": "array", + "items": { + "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }", + "type": "object", + "properties": { + "@type": { + "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.", + "type": "string" + } + }, + "additionalProperties": {} + } + }, + "message": { + "type": "string" + } + } + } + } + } + }, + "post": { + "description": "This also sets the given organization or user as\nfirst collaborator with all possible rights.", + "tags": [ + "ApplicationRegistry" + ], + "summary": "Create a new application.", + "operationId": "ApplicationRegistry_Create2", + "parameters": [ + { + "type": "string", + "description": "This ID shares namespace with user IDs.", + "name": "collaborator.organization_ids.organization_id", "in": "path", "required": true }, @@ -421310,15 +431992,18 @@ "description": "Rights denotes what rights the client will have access to.\nThis information is public and can be seen by any authenticated user in the network.\nUsers that previously authorized this client will have to re-authorize the\nclient after rights are added to this list.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -421336,6 +432021,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -421350,11 +432036,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -421368,6 +432056,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -421377,6 +432066,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -421636,15 +432346,18 @@ "description": "Rights denotes what rights the client will have access to.\nThis information is public and can be seen by any authenticated user in the network.\nUsers that previously authorized this client will have to re-authorize the\nclient after rights are added to this list.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -421662,6 +432375,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -421676,11 +432390,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -421694,6 +432410,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -421703,6 +432420,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -421935,15 +432673,18 @@ "description": "Rights denotes what rights the client will have access to.\nThis information is public and can be seen by any authenticated user in the network.\nUsers that previously authorized this client will have to re-authorize the\nclient after rights are added to this list.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -421961,6 +432702,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -421975,11 +432717,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -421993,6 +432737,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -422002,6 +432747,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -424078,15 +434844,18 @@ "description": "Rights that are granted to this API key.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -424104,6 +434873,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -424118,11 +434888,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -424136,6 +434908,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -424145,6 +434918,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -424225,15 +435019,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -424251,6 +435048,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -424265,11 +435063,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -424283,6 +435083,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -424292,6 +435093,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -424330,15 +435152,18 @@ "description": "Rights that are granted to this API key.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -424356,6 +435181,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -424370,11 +435196,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -424388,6 +435216,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -424397,6 +435226,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -424493,15 +435343,18 @@ "description": "Rights that are granted to this API key.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -424519,6 +435372,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -424533,11 +435387,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -424551,6 +435407,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -424560,6 +435417,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -424611,15 +435489,18 @@ "description": "Rights that are granted to this API key.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -424637,6 +435518,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -424651,11 +435533,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -424669,6 +435553,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -424678,6 +435563,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -424774,15 +435680,18 @@ "description": "Rights that are granted to this API key.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -424800,6 +435709,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -424814,11 +435724,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -424832,6 +435744,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -424841,6 +435754,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -425010,15 +435944,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -425036,6 +435973,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -425050,11 +435988,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -425068,6 +436008,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -425077,6 +436018,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -425194,15 +436156,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -425220,6 +436185,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -425234,11 +436200,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -425252,6 +436220,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -425261,6 +436230,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -425358,15 +436348,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -425384,6 +436377,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -425398,11 +436392,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -425416,6 +436412,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -425425,6 +436422,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -425863,15 +436881,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -425889,6 +436910,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -425903,11 +436925,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -425921,6 +436945,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -425930,6 +436955,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -479197,15 +490243,18 @@ "description": "Rights denotes what rights the client will have access to.\nThis information is public and can be seen by any authenticated user in the network.\nUsers that previously authorized this client will have to re-authorize the\nclient after rights are added to this list.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -479223,6 +490272,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -479237,11 +490287,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -479255,6 +490307,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -479264,6 +490317,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -480948,409 +492022,454 @@ "type": "string", "format": "date-time" }, - "description": { - "type": "string" - }, - "ids": { - "type": "object", - "properties": { - "tenant_id": { - "type": "string" - } - } - }, - "max_applications": { - "description": "If set, restricts the maximum number of applications that can be created.", - "type": "string", - "format": "uint64" - }, - "max_clients": { - "description": "If set, restricts the maximum number of clients that can be created.", - "type": "string", - "format": "uint64" - }, - "max_end_devices": { - "description": "If set, restricts the maximum number of end_devices that can be created.", - "type": "string", - "format": "uint64" - }, - "max_gateways": { - "description": "If set, restricts the maximum number of gateways that can be created.", - "type": "string", - "format": "uint64" - }, - "max_organizations": { - "description": "If set, restricts the maximum number of organizations that can be created.", - "type": "string", - "format": "uint64" - }, - "max_users": { - "description": "If set, restricts the maximum number of users that can be created.", - "type": "string", - "format": "uint64" - }, - "name": { - "type": "string" - }, - "state": { - "description": "State enum defines states that an entity can be in.\n\n - STATE_REQUESTED: Denotes that the entity has been requested and is pending review by an admin.\n - STATE_APPROVED: Denotes that the entity has been reviewed and approved by an admin.\n - STATE_REJECTED: Denotes that the entity has been reviewed and rejected by an admin.\n - STATE_FLAGGED: Denotes that the entity has been flagged and is pending review by an admin.\n - STATE_SUSPENDED: Denotes that the entity has been reviewed and suspended by an admin.", - "type": "string", - "default": "STATE_REQUESTED", - "enum": [ - "STATE_REQUESTED", - "STATE_APPROVED", - "STATE_REJECTED", - "STATE_FLAGGED", - "STATE_SUSPENDED" - ] - }, - "state_description": { - "description": "A description for the state field.\nThis field can only be modified by admins, and should typically only be updated\nwhen also updating `state`.", - "type": "string" - }, - "updated_at": { + "description": { + "type": "string" + }, + "ids": { + "type": "object", + "properties": { + "tenant_id": { + "type": "string" + } + } + }, + "max_applications": { + "description": "If set, restricts the maximum number of applications that can be created.", + "type": "string", + "format": "uint64" + }, + "max_clients": { + "description": "If set, restricts the maximum number of clients that can be created.", + "type": "string", + "format": "uint64" + }, + "max_end_devices": { + "description": "If set, restricts the maximum number of end_devices that can be created.", + "type": "string", + "format": "uint64" + }, + "max_gateways": { + "description": "If set, restricts the maximum number of gateways that can be created.", + "type": "string", + "format": "uint64" + }, + "max_organizations": { + "description": "If set, restricts the maximum number of organizations that can be created.", + "type": "string", + "format": "uint64" + }, + "max_users": { + "description": "If set, restricts the maximum number of users that can be created.", + "type": "string", + "format": "uint64" + }, + "name": { + "type": "string" + }, + "state": { + "description": "State enum defines states that an entity can be in.\n\n - STATE_REQUESTED: Denotes that the entity has been requested and is pending review by an admin.\n - STATE_APPROVED: Denotes that the entity has been reviewed and approved by an admin.\n - STATE_REJECTED: Denotes that the entity has been reviewed and rejected by an admin.\n - STATE_FLAGGED: Denotes that the entity has been flagged and is pending review by an admin.\n - STATE_SUSPENDED: Denotes that the entity has been reviewed and suspended by an admin.", + "type": "string", + "default": "STATE_REQUESTED", + "enum": [ + "STATE_REQUESTED", + "STATE_APPROVED", + "STATE_REJECTED", + "STATE_FLAGGED", + "STATE_SUSPENDED" + ] + }, + "state_description": { + "description": "A description for the state field.\nThis field can only be modified by admins, and should typically only be updated\nwhen also updating `state`.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + } + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "details": { + "type": "array", + "items": { + "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }", + "type": "object", + "properties": { + "@type": { + "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.", + "type": "string" + } + }, + "additionalProperties": {} + } + }, + "message": { + "type": "string" + } + } + } + } + } + } + }, + "/search/users": { + "get": { + "description": "This is only available to admin users.", + "tags": [ + "EntityRegistrySearch" + ], + "summary": "Search for users that match the conditions specified in the request.", + "operationId": "EntityRegistrySearch_SearchUsers", + "parameters": [ + { + "type": "string", + "description": "Find users where the ID, name or description contains this substring.", + "name": "query", + "in": "query" + }, + { + "type": "string", + "description": "Find users where the ID contains this substring.", + "name": "id_contains", + "in": "query" + }, + { + "type": "string", + "description": "Find users where the name contains this substring.", + "name": "name_contains", + "in": "query" + }, + { + "type": "string", + "description": "Find users where the description contains this substring.", + "name": "description_contains", + "in": "query" + }, + { + "type": "string", + "description": "This is a request variable of the map type. The query format is \"map_name[key]=value\", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age[\"bob\"]=18", + "name": "attributes_contain[string]", + "in": "query" + }, + { + "type": "array", + "items": { + "enum": [ + "STATE_REQUESTED", + "STATE_APPROVED", + "STATE_REJECTED", + "STATE_FLAGGED", + "STATE_SUSPENDED" + ], + "type": "string" + }, + "collectionFormat": "multi", + "description": "Find users where the state is any of these states.\n\n - STATE_REQUESTED: Denotes that the entity has been requested and is pending review by an admin.\n - STATE_APPROVED: Denotes that the entity has been reviewed and approved by an admin.\n - STATE_REJECTED: Denotes that the entity has been reviewed and rejected by an admin.\n - STATE_FLAGGED: Denotes that the entity has been flagged and is pending review by an admin.\n - STATE_SUSPENDED: Denotes that the entity has been reviewed and suspended by an admin.", + "name": "state", + "in": "query" + }, + { + "type": "string", + "name": "field_mask", + "in": "query" + }, + { + "type": "string", + "description": "Order the results by this field path (must be present in the field mask).\nDefault ordering is by ID. Prepend with a minus (-) to reverse the order.", + "name": "order", + "in": "query" + }, + { + "type": "integer", + "format": "int64", + "description": "Limit the number of results per page.", + "name": "limit", + "in": "query" + }, + { + "type": "integer", + "format": "int64", + "description": "Page number for pagination. 0 is interpreted as 1.", + "name": "page", + "in": "query" + }, + { + "type": "boolean", + "description": "Only return recently deleted users.", + "name": "deleted", + "in": "query" + } + ], + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "type": "object", + "properties": { + "users": { + "type": "array", + "items": { + "description": "User is the message that defines a user on the network.", + "type": "object", + "properties": { + "admin": { + "description": "This user is an admin.\nThis information is public and can be seen by any authenticated user in the network.\nThis field can only be modified by other admins.", + "type": "boolean" + }, + "application_limit": { + "description": "The maximum number of applications of the user.\nThis field can only be modified by admins.", + "type": "string", + "format": "uint64" + }, + "attributes": { + "description": "Key-value attributes for this users. Typically used for storing integration-specific data.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "client_limit": { + "description": "The maximum number of clients of the user.\nThis field can only be modified by admins.", + "type": "string", + "format": "uint64" + }, + "console_preferences": { + "description": "UserConsolePreferences is the message that defines the user preferences for the Console.", + "type": "object", + "properties": { + "console_theme": { + "description": "ConsoleTheme is the theme of the Console.\n\n - CONSOLE_THEME_SYSTEM: The user prefers the system mode.\n - CONSOLE_THEME_LIGHT: The user prefers the light mode.\n - CONSOLE_THEME_DARK: The user prefers the dark mode.", + "type": "string", + "default": "CONSOLE_THEME_SYSTEM", + "enum": [ + "CONSOLE_THEME_SYSTEM", + "CONSOLE_THEME_LIGHT", + "CONSOLE_THEME_DARK" + ] + }, + "dashboard_layouts": { + "type": "object", + "properties": { + "api_key": { + "description": "DashboardLayout is a set of possible layout values to be used in the Console.", + "type": "string", + "default": "DASHBOARD_LAYOUT_TABLE", + "enum": [ + "DASHBOARD_LAYOUT_TABLE", + "DASHBOARD_LAYOUT_LIST", + "DASHBOARD_LAYOUT_GRID" + ] + }, + "application": { + "description": "DashboardLayout is a set of possible layout values to be used in the Console.", + "type": "string", + "default": "DASHBOARD_LAYOUT_TABLE", + "enum": [ + "DASHBOARD_LAYOUT_TABLE", + "DASHBOARD_LAYOUT_LIST", + "DASHBOARD_LAYOUT_GRID" + ] + }, + "collaborator": { + "description": "DashboardLayout is a set of possible layout values to be used in the Console.", + "type": "string", + "default": "DASHBOARD_LAYOUT_TABLE", + "enum": [ + "DASHBOARD_LAYOUT_TABLE", + "DASHBOARD_LAYOUT_LIST", + "DASHBOARD_LAYOUT_GRID" + ] + }, + "end_device": { + "description": "DashboardLayout is a set of possible layout values to be used in the Console.", + "type": "string", + "default": "DASHBOARD_LAYOUT_TABLE", + "enum": [ + "DASHBOARD_LAYOUT_TABLE", + "DASHBOARD_LAYOUT_LIST", + "DASHBOARD_LAYOUT_GRID" + ] + }, + "gateway": { + "description": "DashboardLayout is a set of possible layout values to be used in the Console.", + "type": "string", + "default": "DASHBOARD_LAYOUT_TABLE", + "enum": [ + "DASHBOARD_LAYOUT_TABLE", + "DASHBOARD_LAYOUT_LIST", + "DASHBOARD_LAYOUT_GRID" + ] + }, + "organization": { + "description": "DashboardLayout is a set of possible layout values to be used in the Console.", + "type": "string", + "default": "DASHBOARD_LAYOUT_TABLE", + "enum": [ + "DASHBOARD_LAYOUT_TABLE", + "DASHBOARD_LAYOUT_LIST", + "DASHBOARD_LAYOUT_GRID" + ] + }, + "overview": { + "description": "DashboardLayout is a set of possible layout values to be used in the Console.", + "type": "string", + "default": "DASHBOARD_LAYOUT_TABLE", + "enum": [ + "DASHBOARD_LAYOUT_TABLE", + "DASHBOARD_LAYOUT_LIST", + "DASHBOARD_LAYOUT_GRID" + ] + }, + "user": { + "description": "DashboardLayout is a set of possible layout values to be used in the Console.", + "type": "string", + "default": "DASHBOARD_LAYOUT_TABLE", + "enum": [ + "DASHBOARD_LAYOUT_TABLE", + "DASHBOARD_LAYOUT_LIST", + "DASHBOARD_LAYOUT_GRID" + ] + } + } + }, + "sort_by": { + "description": "SortBy defines the field to which the Console will sort the display of entities.", + "type": "object", + "properties": { + "api_key": { + "type": "string" + }, + "application": { + "type": "string" + }, + "collaborator": { + "type": "string" + }, + "end_device": { + "type": "string" + }, + "gateway": { + "type": "string" + }, + "organization": { + "type": "string" + }, + "user": { + "type": "string" + } + } + }, + "tutorials": { + "type": "object", + "properties": { + "seen": { + "type": "array", + "items": { + "description": "Tutorial is a set of possible tutorials in the Console.", + "type": "string", + "default": "TUTORIAL_UNKNOWN", + "enum": [ + "TUTORIAL_UNKNOWN", + "TUTORIAL_LIVE_DATA_SPLIT_VIEW" + ] + } + } + } + } + } + }, + "contact_info": { + "description": "Contact information for this user. Typically used to indicate who to contact with security/billing questions about the user.\nThis field is deprecated.", + "type": "array", + "items": { + "type": "object", + "properties": { + "contact_method": { + "type": "string", + "default": "CONTACT_METHOD_OTHER", + "enum": [ + "CONTACT_METHOD_OTHER", + "CONTACT_METHOD_EMAIL", + "CONTACT_METHOD_PHONE" + ] + }, + "contact_type": { + "type": "string", + "default": "CONTACT_TYPE_OTHER", + "enum": [ + "CONTACT_TYPE_OTHER", + "CONTACT_TYPE_ABUSE", + "CONTACT_TYPE_BILLING", + "CONTACT_TYPE_TECHNICAL" + ] + }, + "public": { + "type": "boolean" + }, + "validated_at": { + "type": "string", + "format": "date-time" + }, + "value": { + "type": "string" + } + } + } + }, + "created_at": { + "description": "When the user was created. This information is public and can be seen by any authenticated user in the network.", + "type": "string", + "format": "date-time" + }, + "deleted_at": { + "description": "When the user was deleted. This information is public and can be seen by any authenticated user in the network.", "type": "string", "format": "date-time" - } - } - } - } - } - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "details": { - "type": "array", - "items": { - "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }", - "type": "object", - "properties": { - "@type": { - "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.", - "type": "string" - } - }, - "additionalProperties": {} - } - }, - "message": { - "type": "string" - } - } - } - } - } - } - }, - "/search/users": { - "get": { - "description": "This is only available to admin users.", - "tags": [ - "EntityRegistrySearch" - ], - "summary": "Search for users that match the conditions specified in the request.", - "operationId": "EntityRegistrySearch_SearchUsers", - "parameters": [ - { - "type": "string", - "description": "Find users where the ID, name or description contains this substring.", - "name": "query", - "in": "query" - }, - { - "type": "string", - "description": "Find users where the ID contains this substring.", - "name": "id_contains", - "in": "query" - }, - { - "type": "string", - "description": "Find users where the name contains this substring.", - "name": "name_contains", - "in": "query" - }, - { - "type": "string", - "description": "Find users where the description contains this substring.", - "name": "description_contains", - "in": "query" - }, - { - "type": "string", - "description": "This is a request variable of the map type. The query format is \"map_name[key]=value\", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age[\"bob\"]=18", - "name": "attributes_contain[string]", - "in": "query" - }, - { - "type": "array", - "items": { - "enum": [ - "STATE_REQUESTED", - "STATE_APPROVED", - "STATE_REJECTED", - "STATE_FLAGGED", - "STATE_SUSPENDED" - ], - "type": "string" - }, - "collectionFormat": "multi", - "description": "Find users where the state is any of these states.\n\n - STATE_REQUESTED: Denotes that the entity has been requested and is pending review by an admin.\n - STATE_APPROVED: Denotes that the entity has been reviewed and approved by an admin.\n - STATE_REJECTED: Denotes that the entity has been reviewed and rejected by an admin.\n - STATE_FLAGGED: Denotes that the entity has been flagged and is pending review by an admin.\n - STATE_SUSPENDED: Denotes that the entity has been reviewed and suspended by an admin.", - "name": "state", - "in": "query" - }, - { - "type": "string", - "name": "field_mask", - "in": "query" - }, - { - "type": "string", - "description": "Order the results by this field path (must be present in the field mask).\nDefault ordering is by ID. Prepend with a minus (-) to reverse the order.", - "name": "order", - "in": "query" - }, - { - "type": "integer", - "format": "int64", - "description": "Limit the number of results per page.", - "name": "limit", - "in": "query" - }, - { - "type": "integer", - "format": "int64", - "description": "Page number for pagination. 0 is interpreted as 1.", - "name": "page", - "in": "query" - }, - { - "type": "boolean", - "description": "Only return recently deleted users.", - "name": "deleted", - "in": "query" - } - ], - "responses": { - "200": { - "description": "A successful response.", - "schema": { - "type": "object", - "properties": { - "users": { - "type": "array", - "items": { - "description": "User is the message that defines a user on the network.", - "type": "object", - "properties": { - "admin": { - "description": "This user is an admin.\nThis information is public and can be seen by any authenticated user in the network.\nThis field can only be modified by other admins.", - "type": "boolean" }, - "application_limit": { - "description": "The maximum number of applications of the user.\nThis field can only be modified by admins.", - "type": "string", - "format": "uint64" - }, - "attributes": { - "description": "Key-value attributes for this users. Typically used for storing integration-specific data.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "client_limit": { - "description": "The maximum number of clients of the user.\nThis field can only be modified by admins.", - "type": "string", - "format": "uint64" + "description": { + "description": "A description for the user. This information is public and can be seen by any authenticated user in the network.", + "type": "string" }, - "console_preferences": { - "description": "UserConsolePreferences is the message that defines the user preferences for the Console.", + "email_notification_preferences": { + "description": "EmailNotificationPreferences is the message that defines the types of notifications for which the user wants to receive an email.", "type": "object", "properties": { - "console_theme": { - "description": "ConsoleTheme is the theme of the Console.\n\n - CONSOLE_THEME_SYSTEM: The user prefers the system mode.\n - CONSOLE_THEME_LIGHT: The user prefers the light mode.\n - CONSOLE_THEME_DARK: The user prefers the dark mode.", - "type": "string", - "default": "CONSOLE_THEME_SYSTEM", - "enum": [ - "CONSOLE_THEME_SYSTEM", - "CONSOLE_THEME_LIGHT", - "CONSOLE_THEME_DARK" - ] - }, - "dashboard_layouts": { - "type": "object", - "properties": { - "api_key": { - "description": "DashboardLayout is a set of possible layout values to be used in the Console.", - "type": "string", - "default": "DASHBOARD_LAYOUT_TABLE", - "enum": [ - "DASHBOARD_LAYOUT_TABLE", - "DASHBOARD_LAYOUT_LIST", - "DASHBOARD_LAYOUT_GRID" - ] - }, - "application": { - "description": "DashboardLayout is a set of possible layout values to be used in the Console.", - "type": "string", - "default": "DASHBOARD_LAYOUT_TABLE", - "enum": [ - "DASHBOARD_LAYOUT_TABLE", - "DASHBOARD_LAYOUT_LIST", - "DASHBOARD_LAYOUT_GRID" - ] - }, - "collaborator": { - "description": "DashboardLayout is a set of possible layout values to be used in the Console.", - "type": "string", - "default": "DASHBOARD_LAYOUT_TABLE", - "enum": [ - "DASHBOARD_LAYOUT_TABLE", - "DASHBOARD_LAYOUT_LIST", - "DASHBOARD_LAYOUT_GRID" - ] - }, - "end_device": { - "description": "DashboardLayout is a set of possible layout values to be used in the Console.", - "type": "string", - "default": "DASHBOARD_LAYOUT_TABLE", - "enum": [ - "DASHBOARD_LAYOUT_TABLE", - "DASHBOARD_LAYOUT_LIST", - "DASHBOARD_LAYOUT_GRID" - ] - }, - "gateway": { - "description": "DashboardLayout is a set of possible layout values to be used in the Console.", - "type": "string", - "default": "DASHBOARD_LAYOUT_TABLE", - "enum": [ - "DASHBOARD_LAYOUT_TABLE", - "DASHBOARD_LAYOUT_LIST", - "DASHBOARD_LAYOUT_GRID" - ] - }, - "organization": { - "description": "DashboardLayout is a set of possible layout values to be used in the Console.", - "type": "string", - "default": "DASHBOARD_LAYOUT_TABLE", - "enum": [ - "DASHBOARD_LAYOUT_TABLE", - "DASHBOARD_LAYOUT_LIST", - "DASHBOARD_LAYOUT_GRID" - ] - }, - "overview": { - "description": "DashboardLayout is a set of possible layout values to be used in the Console.", - "type": "string", - "default": "DASHBOARD_LAYOUT_TABLE", - "enum": [ - "DASHBOARD_LAYOUT_TABLE", - "DASHBOARD_LAYOUT_LIST", - "DASHBOARD_LAYOUT_GRID" - ] - }, - "user": { - "description": "DashboardLayout is a set of possible layout values to be used in the Console.", - "type": "string", - "default": "DASHBOARD_LAYOUT_TABLE", - "enum": [ - "DASHBOARD_LAYOUT_TABLE", - "DASHBOARD_LAYOUT_LIST", - "DASHBOARD_LAYOUT_GRID" - ] - } - } - }, - "sort_by": { - "description": "SortBy defines the field to which the Console will sort the display of entities.", - "type": "object", - "properties": { - "api_key": { - "type": "string" - }, - "application": { - "type": "string" - }, - "collaborator": { - "type": "string" - }, - "end_device": { - "type": "string" - }, - "gateway": { - "type": "string" - }, - "organization": { - "type": "string" - }, - "user": { - "type": "string" - } - } - } - } - }, - "contact_info": { - "description": "Contact information for this user. Typically used to indicate who to contact with security/billing questions about the user.\nThis field is deprecated.", - "type": "array", - "items": { - "type": "object", - "properties": { - "contact_method": { - "type": "string", - "default": "CONTACT_METHOD_OTHER", - "enum": [ - "CONTACT_METHOD_OTHER", - "CONTACT_METHOD_EMAIL", - "CONTACT_METHOD_PHONE" - ] - }, - "contact_type": { + "types": { + "type": "array", + "items": { "type": "string", - "default": "CONTACT_TYPE_OTHER", + "default": "UNKNOWN", "enum": [ - "CONTACT_TYPE_OTHER", - "CONTACT_TYPE_ABUSE", - "CONTACT_TYPE_BILLING", - "CONTACT_TYPE_TECHNICAL" + "UNKNOWN", + "API_KEY_CREATED", + "API_KEY_CHANGED", + "CLIENT_REQUESTED", + "COLLABORATOR_CHANGED", + "ENTITY_STATE_CHANGED", + "INVITATION", + "LOGIN_TOKEN", + "PASSWORD_CHANGED", + "TEMPORARY_PASSWORD", + "USER_REQUESTED", + "VALIDATE", + "SUPPORT_ACCESS_REQUESTED" ] - }, - "public": { - "type": "boolean" - }, - "validated_at": { - "type": "string", - "format": "date-time" - }, - "value": { - "type": "string" } } } }, - "created_at": { - "description": "When the user was created. This information is public and can be seen by any authenticated user in the network.", - "type": "string", - "format": "date-time" - }, - "deleted_at": { - "description": "When the user was deleted. This information is public and can be seen by any authenticated user in the network.", - "type": "string", - "format": "date-time" - }, - "description": { - "description": "A description for the user. This information is public and can be seen by any authenticated user in the network.", - "type": "string" - }, "gateway_limit": { "description": "The maximum number of gateways of the user.\nThis field can only be modified by admins.", "type": "string", @@ -481452,6 +492571,109 @@ "type": "string", "format": "date-time" }, + "universal_rights": { + "description": "Universal rights are capable of restricting the user's interactions with the API, be it an admin or not.", + "type": "array", + "items": { + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "type": "string", + "default": "right_invalid", + "enum": [ + "right_invalid", + "RIGHT_USER_INFO", + "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", + "RIGHT_USER_SETTINGS_API_KEYS", + "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", + "RIGHT_USER_AUTHORIZED_CLIENTS", + "RIGHT_USER_APPLICATIONS_LIST", + "RIGHT_USER_APPLICATIONS_CREATE", + "RIGHT_USER_GATEWAYS_LIST", + "RIGHT_USER_GATEWAYS_CREATE", + "RIGHT_USER_CLIENTS_LIST", + "RIGHT_USER_CLIENTS_CREATE", + "RIGHT_USER_ORGANIZATIONS_LIST", + "RIGHT_USER_ORGANIZATIONS_CREATE", + "RIGHT_USER_NOTIFICATIONS_READ", + "RIGHT_USER_ALL", + "RIGHT_APPLICATION_INFO", + "RIGHT_APPLICATION_SETTINGS_BASIC", + "RIGHT_APPLICATION_SETTINGS_API_KEYS", + "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", + "RIGHT_APPLICATION_SETTINGS_PACKAGES", + "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", + "RIGHT_APPLICATION_DEVICES_READ", + "RIGHT_APPLICATION_DEVICES_WRITE", + "RIGHT_APPLICATION_DEVICES_READ_KEYS", + "RIGHT_APPLICATION_DEVICES_WRITE_KEYS", + "RIGHT_APPLICATION_TRAFFIC_READ", + "RIGHT_APPLICATION_TRAFFIC_UP_WRITE", + "RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE", + "RIGHT_APPLICATION_LINK", + "RIGHT_APPLICATION_ALL", + "RIGHT_CLIENT_ALL", + "RIGHT_CLIENT_INFO", + "RIGHT_CLIENT_SETTINGS_BASIC", + "RIGHT_CLIENT_SETTINGS_COLLABORATORS", + "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", + "RIGHT_GATEWAY_INFO", + "RIGHT_GATEWAY_SETTINGS_BASIC", + "RIGHT_GATEWAY_SETTINGS_API_KEYS", + "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", + "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", + "RIGHT_GATEWAY_TRAFFIC_READ", + "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", + "RIGHT_GATEWAY_LINK", + "RIGHT_GATEWAY_STATUS_READ", + "RIGHT_GATEWAY_LOCATION_READ", + "RIGHT_GATEWAY_WRITE_SECRETS", + "RIGHT_GATEWAY_READ_SECRETS", + "RIGHT_GATEWAY_ALL", + "RIGHT_ORGANIZATION_INFO", + "RIGHT_ORGANIZATION_SETTINGS_BASIC", + "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", + "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", + "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", + "RIGHT_ORGANIZATION_APPLICATIONS_LIST", + "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", + "RIGHT_ORGANIZATION_GATEWAYS_LIST", + "RIGHT_ORGANIZATION_GATEWAYS_CREATE", + "RIGHT_ORGANIZATION_CLIENTS_LIST", + "RIGHT_ORGANIZATION_CLIENTS_CREATE", + "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", + "RIGHT_ORGANIZATION_ALL", + "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", + "RIGHT_ALL" + ] + } + }, "updated_at": { "description": "When the user was last updated. This information is public and can be seen by any authenticated user in the network.", "type": "string", @@ -482573,6 +493795,23 @@ "type": "string" } } + }, + "tutorials": { + "type": "object", + "properties": { + "seen": { + "type": "array", + "items": { + "description": "Tutorial is a set of possible tutorials in the Console.", + "type": "string", + "default": "TUTORIAL_UNKNOWN", + "enum": [ + "TUTORIAL_UNKNOWN", + "TUTORIAL_LIVE_DATA_SPLIT_VIEW" + ] + } + } + } } } }, @@ -482628,6 +493867,34 @@ "description": "A description for the user. This information is public and can be seen by any authenticated user in the network.", "type": "string" }, + "email_notification_preferences": { + "description": "EmailNotificationPreferences is the message that defines the types of notifications for which the user wants to receive an email.", + "type": "object", + "properties": { + "types": { + "type": "array", + "items": { + "type": "string", + "default": "UNKNOWN", + "enum": [ + "UNKNOWN", + "API_KEY_CREATED", + "API_KEY_CHANGED", + "CLIENT_REQUESTED", + "COLLABORATOR_CHANGED", + "ENTITY_STATE_CHANGED", + "INVITATION", + "LOGIN_TOKEN", + "PASSWORD_CHANGED", + "TEMPORARY_PASSWORD", + "USER_REQUESTED", + "VALIDATE", + "SUPPORT_ACCESS_REQUESTED" + ] + } + } + } + }, "gateway_limit": { "description": "The maximum number of gateways of the user.\nThis field can only be modified by admins.", "type": "string", @@ -482729,6 +493996,109 @@ "type": "string", "format": "date-time" }, + "universal_rights": { + "description": "Universal rights are capable of restricting the user's interactions with the API, be it an admin or not.", + "type": "array", + "items": { + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "type": "string", + "default": "right_invalid", + "enum": [ + "right_invalid", + "RIGHT_USER_INFO", + "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", + "RIGHT_USER_SETTINGS_API_KEYS", + "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", + "RIGHT_USER_AUTHORIZED_CLIENTS", + "RIGHT_USER_APPLICATIONS_LIST", + "RIGHT_USER_APPLICATIONS_CREATE", + "RIGHT_USER_GATEWAYS_LIST", + "RIGHT_USER_GATEWAYS_CREATE", + "RIGHT_USER_CLIENTS_LIST", + "RIGHT_USER_CLIENTS_CREATE", + "RIGHT_USER_ORGANIZATIONS_LIST", + "RIGHT_USER_ORGANIZATIONS_CREATE", + "RIGHT_USER_NOTIFICATIONS_READ", + "RIGHT_USER_ALL", + "RIGHT_APPLICATION_INFO", + "RIGHT_APPLICATION_SETTINGS_BASIC", + "RIGHT_APPLICATION_SETTINGS_API_KEYS", + "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", + "RIGHT_APPLICATION_SETTINGS_PACKAGES", + "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", + "RIGHT_APPLICATION_DEVICES_READ", + "RIGHT_APPLICATION_DEVICES_WRITE", + "RIGHT_APPLICATION_DEVICES_READ_KEYS", + "RIGHT_APPLICATION_DEVICES_WRITE_KEYS", + "RIGHT_APPLICATION_TRAFFIC_READ", + "RIGHT_APPLICATION_TRAFFIC_UP_WRITE", + "RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE", + "RIGHT_APPLICATION_LINK", + "RIGHT_APPLICATION_ALL", + "RIGHT_CLIENT_ALL", + "RIGHT_CLIENT_INFO", + "RIGHT_CLIENT_SETTINGS_BASIC", + "RIGHT_CLIENT_SETTINGS_COLLABORATORS", + "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", + "RIGHT_GATEWAY_INFO", + "RIGHT_GATEWAY_SETTINGS_BASIC", + "RIGHT_GATEWAY_SETTINGS_API_KEYS", + "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", + "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", + "RIGHT_GATEWAY_TRAFFIC_READ", + "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", + "RIGHT_GATEWAY_LINK", + "RIGHT_GATEWAY_STATUS_READ", + "RIGHT_GATEWAY_LOCATION_READ", + "RIGHT_GATEWAY_WRITE_SECRETS", + "RIGHT_GATEWAY_READ_SECRETS", + "RIGHT_GATEWAY_ALL", + "RIGHT_ORGANIZATION_INFO", + "RIGHT_ORGANIZATION_SETTINGS_BASIC", + "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", + "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", + "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", + "RIGHT_ORGANIZATION_APPLICATIONS_LIST", + "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", + "RIGHT_ORGANIZATION_GATEWAYS_LIST", + "RIGHT_ORGANIZATION_GATEWAYS_CREATE", + "RIGHT_ORGANIZATION_CLIENTS_LIST", + "RIGHT_ORGANIZATION_CLIENTS_CREATE", + "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", + "RIGHT_ORGANIZATION_ALL", + "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", + "RIGHT_ALL" + ] + } + }, "updated_at": { "description": "When the user was last updated. This information is public and can be seen by any authenticated user in the network.", "type": "string", @@ -487135,6 +498505,81 @@ } } }, + "/tenants/{tenant_ids.tenant_id}/support-token": { + "post": { + "tags": [ + "TenantAccess" + ], + "summary": "EXPERIMENTAL: This service is subject to change.", + "operationId": "TenantAccess_CreateSupportToken", + "parameters": [ + { + "type": "string", + "name": "tenant_ids.tenant_id", + "in": "path", + "required": true + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "tenant_ids": { + "type": "object" + } + } + } + } + ], + "responses": { + "200": { + "description": "A successful response.", + "schema": { + "type": "object", + "properties": { + "login_token": { + "type": "string" + }, + "login_url": { + "type": "string" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "details": { + "type": "array", + "items": { + "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }", + "type": "object", + "properties": { + "@type": { + "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.", + "type": "string" + } + }, + "additionalProperties": {} + } + }, + "message": { + "type": "string" + } + } + } + } + } + } + }, "/tenants/{tenant_id}": { "delete": { "tags": [ @@ -487388,6 +498833,23 @@ "type": "string" } } + }, + "tutorials": { + "type": "object", + "properties": { + "seen": { + "type": "array", + "items": { + "description": "Tutorial is a set of possible tutorials in the Console.", + "type": "string", + "default": "TUTORIAL_UNKNOWN", + "enum": [ + "TUTORIAL_UNKNOWN", + "TUTORIAL_LIVE_DATA_SPLIT_VIEW" + ] + } + } + } } } }, @@ -487443,6 +498905,34 @@ "description": "A description for the user. This information is public and can be seen by any authenticated user in the network.", "type": "string" }, + "email_notification_preferences": { + "description": "EmailNotificationPreferences is the message that defines the types of notifications for which the user wants to receive an email.", + "type": "object", + "properties": { + "types": { + "type": "array", + "items": { + "type": "string", + "default": "UNKNOWN", + "enum": [ + "UNKNOWN", + "API_KEY_CREATED", + "API_KEY_CHANGED", + "CLIENT_REQUESTED", + "COLLABORATOR_CHANGED", + "ENTITY_STATE_CHANGED", + "INVITATION", + "LOGIN_TOKEN", + "PASSWORD_CHANGED", + "TEMPORARY_PASSWORD", + "USER_REQUESTED", + "VALIDATE", + "SUPPORT_ACCESS_REQUESTED" + ] + } + } + } + }, "gateway_limit": { "description": "The maximum number of gateways of the user.\nThis field can only be modified by admins.", "type": "string", @@ -487544,6 +499034,109 @@ "type": "string", "format": "date-time" }, + "universal_rights": { + "description": "Universal rights are capable of restricting the user's interactions with the API, be it an admin or not.", + "type": "array", + "items": { + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "type": "string", + "default": "right_invalid", + "enum": [ + "right_invalid", + "RIGHT_USER_INFO", + "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", + "RIGHT_USER_SETTINGS_API_KEYS", + "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", + "RIGHT_USER_AUTHORIZED_CLIENTS", + "RIGHT_USER_APPLICATIONS_LIST", + "RIGHT_USER_APPLICATIONS_CREATE", + "RIGHT_USER_GATEWAYS_LIST", + "RIGHT_USER_GATEWAYS_CREATE", + "RIGHT_USER_CLIENTS_LIST", + "RIGHT_USER_CLIENTS_CREATE", + "RIGHT_USER_ORGANIZATIONS_LIST", + "RIGHT_USER_ORGANIZATIONS_CREATE", + "RIGHT_USER_NOTIFICATIONS_READ", + "RIGHT_USER_ALL", + "RIGHT_APPLICATION_INFO", + "RIGHT_APPLICATION_SETTINGS_BASIC", + "RIGHT_APPLICATION_SETTINGS_API_KEYS", + "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", + "RIGHT_APPLICATION_SETTINGS_PACKAGES", + "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", + "RIGHT_APPLICATION_DEVICES_READ", + "RIGHT_APPLICATION_DEVICES_WRITE", + "RIGHT_APPLICATION_DEVICES_READ_KEYS", + "RIGHT_APPLICATION_DEVICES_WRITE_KEYS", + "RIGHT_APPLICATION_TRAFFIC_READ", + "RIGHT_APPLICATION_TRAFFIC_UP_WRITE", + "RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE", + "RIGHT_APPLICATION_LINK", + "RIGHT_APPLICATION_ALL", + "RIGHT_CLIENT_ALL", + "RIGHT_CLIENT_INFO", + "RIGHT_CLIENT_SETTINGS_BASIC", + "RIGHT_CLIENT_SETTINGS_COLLABORATORS", + "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", + "RIGHT_GATEWAY_INFO", + "RIGHT_GATEWAY_SETTINGS_BASIC", + "RIGHT_GATEWAY_SETTINGS_API_KEYS", + "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", + "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", + "RIGHT_GATEWAY_TRAFFIC_READ", + "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", + "RIGHT_GATEWAY_LINK", + "RIGHT_GATEWAY_STATUS_READ", + "RIGHT_GATEWAY_LOCATION_READ", + "RIGHT_GATEWAY_WRITE_SECRETS", + "RIGHT_GATEWAY_READ_SECRETS", + "RIGHT_GATEWAY_ALL", + "RIGHT_ORGANIZATION_INFO", + "RIGHT_ORGANIZATION_SETTINGS_BASIC", + "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", + "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", + "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", + "RIGHT_ORGANIZATION_APPLICATIONS_LIST", + "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", + "RIGHT_ORGANIZATION_GATEWAYS_LIST", + "RIGHT_ORGANIZATION_GATEWAYS_CREATE", + "RIGHT_ORGANIZATION_CLIENTS_LIST", + "RIGHT_ORGANIZATION_CLIENTS_CREATE", + "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", + "RIGHT_ORGANIZATION_ALL", + "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", + "RIGHT_ALL" + ] + } + }, "updated_at": { "description": "When the user was last updated. This information is public and can be seen by any authenticated user in the network.", "type": "string", @@ -487755,6 +499348,23 @@ "type": "string" } } + }, + "tutorials": { + "type": "object", + "properties": { + "seen": { + "type": "array", + "items": { + "description": "Tutorial is a set of possible tutorials in the Console.", + "type": "string", + "default": "TUTORIAL_UNKNOWN", + "enum": [ + "TUTORIAL_UNKNOWN", + "TUTORIAL_LIVE_DATA_SPLIT_VIEW" + ] + } + } + } } } }, @@ -487810,6 +499420,34 @@ "description": "A description for the user. This information is public and can be seen by any authenticated user in the network.", "type": "string" }, + "email_notification_preferences": { + "description": "EmailNotificationPreferences is the message that defines the types of notifications for which the user wants to receive an email.", + "type": "object", + "properties": { + "types": { + "type": "array", + "items": { + "type": "string", + "default": "UNKNOWN", + "enum": [ + "UNKNOWN", + "API_KEY_CREATED", + "API_KEY_CHANGED", + "CLIENT_REQUESTED", + "COLLABORATOR_CHANGED", + "ENTITY_STATE_CHANGED", + "INVITATION", + "LOGIN_TOKEN", + "PASSWORD_CHANGED", + "TEMPORARY_PASSWORD", + "USER_REQUESTED", + "VALIDATE", + "SUPPORT_ACCESS_REQUESTED" + ] + } + } + } + }, "gateway_limit": { "description": "The maximum number of gateways of the user.\nThis field can only be modified by admins.", "type": "string", @@ -487911,6 +499549,109 @@ "type": "string", "format": "date-time" }, + "universal_rights": { + "description": "Universal rights are capable of restricting the user's interactions with the API, be it an admin or not.", + "type": "array", + "items": { + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "type": "string", + "default": "right_invalid", + "enum": [ + "right_invalid", + "RIGHT_USER_INFO", + "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", + "RIGHT_USER_SETTINGS_API_KEYS", + "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", + "RIGHT_USER_AUTHORIZED_CLIENTS", + "RIGHT_USER_APPLICATIONS_LIST", + "RIGHT_USER_APPLICATIONS_CREATE", + "RIGHT_USER_GATEWAYS_LIST", + "RIGHT_USER_GATEWAYS_CREATE", + "RIGHT_USER_CLIENTS_LIST", + "RIGHT_USER_CLIENTS_CREATE", + "RIGHT_USER_ORGANIZATIONS_LIST", + "RIGHT_USER_ORGANIZATIONS_CREATE", + "RIGHT_USER_NOTIFICATIONS_READ", + "RIGHT_USER_ALL", + "RIGHT_APPLICATION_INFO", + "RIGHT_APPLICATION_SETTINGS_BASIC", + "RIGHT_APPLICATION_SETTINGS_API_KEYS", + "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", + "RIGHT_APPLICATION_SETTINGS_PACKAGES", + "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", + "RIGHT_APPLICATION_DEVICES_READ", + "RIGHT_APPLICATION_DEVICES_WRITE", + "RIGHT_APPLICATION_DEVICES_READ_KEYS", + "RIGHT_APPLICATION_DEVICES_WRITE_KEYS", + "RIGHT_APPLICATION_TRAFFIC_READ", + "RIGHT_APPLICATION_TRAFFIC_UP_WRITE", + "RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE", + "RIGHT_APPLICATION_LINK", + "RIGHT_APPLICATION_ALL", + "RIGHT_CLIENT_ALL", + "RIGHT_CLIENT_INFO", + "RIGHT_CLIENT_SETTINGS_BASIC", + "RIGHT_CLIENT_SETTINGS_COLLABORATORS", + "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", + "RIGHT_GATEWAY_INFO", + "RIGHT_GATEWAY_SETTINGS_BASIC", + "RIGHT_GATEWAY_SETTINGS_API_KEYS", + "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", + "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", + "RIGHT_GATEWAY_TRAFFIC_READ", + "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", + "RIGHT_GATEWAY_LINK", + "RIGHT_GATEWAY_STATUS_READ", + "RIGHT_GATEWAY_LOCATION_READ", + "RIGHT_GATEWAY_WRITE_SECRETS", + "RIGHT_GATEWAY_READ_SECRETS", + "RIGHT_GATEWAY_ALL", + "RIGHT_ORGANIZATION_INFO", + "RIGHT_ORGANIZATION_SETTINGS_BASIC", + "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", + "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", + "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", + "RIGHT_ORGANIZATION_APPLICATIONS_LIST", + "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", + "RIGHT_ORGANIZATION_GATEWAYS_LIST", + "RIGHT_ORGANIZATION_GATEWAYS_CREATE", + "RIGHT_ORGANIZATION_CLIENTS_LIST", + "RIGHT_ORGANIZATION_CLIENTS_CREATE", + "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", + "RIGHT_ORGANIZATION_ALL", + "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", + "RIGHT_ALL" + ] + } + }, "updated_at": { "description": "When the user was last updated. This information is public and can be seen by any authenticated user in the network.", "type": "string", @@ -488075,6 +499816,23 @@ "type": "string" } } + }, + "tutorials": { + "type": "object", + "properties": { + "seen": { + "type": "array", + "items": { + "description": "Tutorial is a set of possible tutorials in the Console.", + "type": "string", + "default": "TUTORIAL_UNKNOWN", + "enum": [ + "TUTORIAL_UNKNOWN", + "TUTORIAL_LIVE_DATA_SPLIT_VIEW" + ] + } + } + } } } }, @@ -488130,6 +499888,34 @@ "description": "A description for the user. This information is public and can be seen by any authenticated user in the network.", "type": "string" }, + "email_notification_preferences": { + "description": "EmailNotificationPreferences is the message that defines the types of notifications for which the user wants to receive an email.", + "type": "object", + "properties": { + "types": { + "type": "array", + "items": { + "type": "string", + "default": "UNKNOWN", + "enum": [ + "UNKNOWN", + "API_KEY_CREATED", + "API_KEY_CHANGED", + "CLIENT_REQUESTED", + "COLLABORATOR_CHANGED", + "ENTITY_STATE_CHANGED", + "INVITATION", + "LOGIN_TOKEN", + "PASSWORD_CHANGED", + "TEMPORARY_PASSWORD", + "USER_REQUESTED", + "VALIDATE", + "SUPPORT_ACCESS_REQUESTED" + ] + } + } + } + }, "gateway_limit": { "description": "The maximum number of gateways of the user.\nThis field can only be modified by admins.", "type": "string", @@ -488231,6 +500017,109 @@ "type": "string", "format": "date-time" }, + "universal_rights": { + "description": "Universal rights are capable of restricting the user's interactions with the API, be it an admin or not.", + "type": "array", + "items": { + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "type": "string", + "default": "right_invalid", + "enum": [ + "right_invalid", + "RIGHT_USER_INFO", + "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", + "RIGHT_USER_SETTINGS_API_KEYS", + "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", + "RIGHT_USER_AUTHORIZED_CLIENTS", + "RIGHT_USER_APPLICATIONS_LIST", + "RIGHT_USER_APPLICATIONS_CREATE", + "RIGHT_USER_GATEWAYS_LIST", + "RIGHT_USER_GATEWAYS_CREATE", + "RIGHT_USER_CLIENTS_LIST", + "RIGHT_USER_CLIENTS_CREATE", + "RIGHT_USER_ORGANIZATIONS_LIST", + "RIGHT_USER_ORGANIZATIONS_CREATE", + "RIGHT_USER_NOTIFICATIONS_READ", + "RIGHT_USER_ALL", + "RIGHT_APPLICATION_INFO", + "RIGHT_APPLICATION_SETTINGS_BASIC", + "RIGHT_APPLICATION_SETTINGS_API_KEYS", + "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", + "RIGHT_APPLICATION_SETTINGS_PACKAGES", + "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", + "RIGHT_APPLICATION_DEVICES_READ", + "RIGHT_APPLICATION_DEVICES_WRITE", + "RIGHT_APPLICATION_DEVICES_READ_KEYS", + "RIGHT_APPLICATION_DEVICES_WRITE_KEYS", + "RIGHT_APPLICATION_TRAFFIC_READ", + "RIGHT_APPLICATION_TRAFFIC_UP_WRITE", + "RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE", + "RIGHT_APPLICATION_LINK", + "RIGHT_APPLICATION_ALL", + "RIGHT_CLIENT_ALL", + "RIGHT_CLIENT_INFO", + "RIGHT_CLIENT_SETTINGS_BASIC", + "RIGHT_CLIENT_SETTINGS_COLLABORATORS", + "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", + "RIGHT_GATEWAY_INFO", + "RIGHT_GATEWAY_SETTINGS_BASIC", + "RIGHT_GATEWAY_SETTINGS_API_KEYS", + "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", + "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", + "RIGHT_GATEWAY_TRAFFIC_READ", + "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", + "RIGHT_GATEWAY_LINK", + "RIGHT_GATEWAY_STATUS_READ", + "RIGHT_GATEWAY_LOCATION_READ", + "RIGHT_GATEWAY_WRITE_SECRETS", + "RIGHT_GATEWAY_READ_SECRETS", + "RIGHT_GATEWAY_ALL", + "RIGHT_ORGANIZATION_INFO", + "RIGHT_ORGANIZATION_SETTINGS_BASIC", + "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", + "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", + "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", + "RIGHT_ORGANIZATION_APPLICATIONS_LIST", + "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", + "RIGHT_ORGANIZATION_GATEWAYS_LIST", + "RIGHT_ORGANIZATION_GATEWAYS_CREATE", + "RIGHT_ORGANIZATION_CLIENTS_LIST", + "RIGHT_ORGANIZATION_CLIENTS_CREATE", + "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", + "RIGHT_ORGANIZATION_ALL", + "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", + "RIGHT_ALL" + ] + } + }, "updated_at": { "description": "When the user was last updated. This information is public and can be seen by any authenticated user in the network.", "type": "string", @@ -489145,15 +501034,18 @@ "description": "Rights denotes what rights the client will have access to.\nThis information is public and can be seen by any authenticated user in the network.\nUsers that previously authorized this client will have to re-authorize the\nclient after rights are added to this list.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -489171,6 +501063,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -489185,11 +501078,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -489203,6 +501098,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -489212,6 +501108,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -489471,15 +501388,18 @@ "description": "Rights denotes what rights the client will have access to.\nThis information is public and can be seen by any authenticated user in the network.\nUsers that previously authorized this client will have to re-authorize the\nclient after rights are added to this list.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -489497,6 +501417,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -489511,11 +501432,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -489529,6 +501452,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -489538,6 +501462,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -489770,15 +501715,18 @@ "description": "Rights denotes what rights the client will have access to.\nThis information is public and can be seen by any authenticated user in the network.\nUsers that previously authorized this client will have to re-authorize the\nclient after rights are added to this list.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -489796,6 +501744,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -489810,11 +501759,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -489828,6 +501779,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -489837,6 +501789,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -492092,7 +504065,7 @@ "type": "string" }, "notification_type": { - "description": "The type of this notification.", + "description": "The type of this notification.\nTODO: Replace with type NotificationType in v4 https://github.com/TheThingsNetwork/lorawan-stack/issues/7384.", "type": "string" }, "receivers": { @@ -492442,6 +504415,23 @@ "type": "string" } } + }, + "tutorials": { + "type": "object", + "properties": { + "seen": { + "type": "array", + "items": { + "description": "Tutorial is a set of possible tutorials in the Console.", + "type": "string", + "default": "TUTORIAL_UNKNOWN", + "enum": [ + "TUTORIAL_UNKNOWN", + "TUTORIAL_LIVE_DATA_SPLIT_VIEW" + ] + } + } + } } } }, @@ -492497,6 +504487,34 @@ "description": "A description for the user. This information is public and can be seen by any authenticated user in the network.", "type": "string" }, + "email_notification_preferences": { + "description": "EmailNotificationPreferences is the message that defines the types of notifications for which the user wants to receive an email.", + "type": "object", + "properties": { + "types": { + "type": "array", + "items": { + "type": "string", + "default": "UNKNOWN", + "enum": [ + "UNKNOWN", + "API_KEY_CREATED", + "API_KEY_CHANGED", + "CLIENT_REQUESTED", + "COLLABORATOR_CHANGED", + "ENTITY_STATE_CHANGED", + "INVITATION", + "LOGIN_TOKEN", + "PASSWORD_CHANGED", + "TEMPORARY_PASSWORD", + "USER_REQUESTED", + "VALIDATE", + "SUPPORT_ACCESS_REQUESTED" + ] + } + } + } + }, "gateway_limit": { "description": "The maximum number of gateways of the user.\nThis field can only be modified by admins.", "type": "string", @@ -492596,6 +504614,109 @@ "type": "string", "format": "date-time" }, + "universal_rights": { + "description": "Universal rights are capable of restricting the user's interactions with the API, be it an admin or not.", + "type": "array", + "items": { + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "type": "string", + "default": "right_invalid", + "enum": [ + "right_invalid", + "RIGHT_USER_INFO", + "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", + "RIGHT_USER_SETTINGS_API_KEYS", + "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", + "RIGHT_USER_AUTHORIZED_CLIENTS", + "RIGHT_USER_APPLICATIONS_LIST", + "RIGHT_USER_APPLICATIONS_CREATE", + "RIGHT_USER_GATEWAYS_LIST", + "RIGHT_USER_GATEWAYS_CREATE", + "RIGHT_USER_CLIENTS_LIST", + "RIGHT_USER_CLIENTS_CREATE", + "RIGHT_USER_ORGANIZATIONS_LIST", + "RIGHT_USER_ORGANIZATIONS_CREATE", + "RIGHT_USER_NOTIFICATIONS_READ", + "RIGHT_USER_ALL", + "RIGHT_APPLICATION_INFO", + "RIGHT_APPLICATION_SETTINGS_BASIC", + "RIGHT_APPLICATION_SETTINGS_API_KEYS", + "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", + "RIGHT_APPLICATION_SETTINGS_PACKAGES", + "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", + "RIGHT_APPLICATION_DEVICES_READ", + "RIGHT_APPLICATION_DEVICES_WRITE", + "RIGHT_APPLICATION_DEVICES_READ_KEYS", + "RIGHT_APPLICATION_DEVICES_WRITE_KEYS", + "RIGHT_APPLICATION_TRAFFIC_READ", + "RIGHT_APPLICATION_TRAFFIC_UP_WRITE", + "RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE", + "RIGHT_APPLICATION_LINK", + "RIGHT_APPLICATION_ALL", + "RIGHT_CLIENT_ALL", + "RIGHT_CLIENT_INFO", + "RIGHT_CLIENT_SETTINGS_BASIC", + "RIGHT_CLIENT_SETTINGS_COLLABORATORS", + "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", + "RIGHT_GATEWAY_INFO", + "RIGHT_GATEWAY_SETTINGS_BASIC", + "RIGHT_GATEWAY_SETTINGS_API_KEYS", + "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", + "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", + "RIGHT_GATEWAY_TRAFFIC_READ", + "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", + "RIGHT_GATEWAY_LINK", + "RIGHT_GATEWAY_STATUS_READ", + "RIGHT_GATEWAY_LOCATION_READ", + "RIGHT_GATEWAY_WRITE_SECRETS", + "RIGHT_GATEWAY_READ_SECRETS", + "RIGHT_GATEWAY_ALL", + "RIGHT_ORGANIZATION_INFO", + "RIGHT_ORGANIZATION_SETTINGS_BASIC", + "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", + "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", + "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", + "RIGHT_ORGANIZATION_APPLICATIONS_LIST", + "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", + "RIGHT_ORGANIZATION_GATEWAYS_LIST", + "RIGHT_ORGANIZATION_GATEWAYS_CREATE", + "RIGHT_ORGANIZATION_CLIENTS_LIST", + "RIGHT_ORGANIZATION_CLIENTS_CREATE", + "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", + "RIGHT_ORGANIZATION_ALL", + "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", + "RIGHT_ALL" + ] + } + }, "updated_at": { "description": "When the user was last updated. This information is public and can be seen by any authenticated user in the network.", "type": "string", @@ -492760,6 +504881,23 @@ "type": "string" } } + }, + "tutorials": { + "type": "object", + "properties": { + "seen": { + "type": "array", + "items": { + "description": "Tutorial is a set of possible tutorials in the Console.", + "type": "string", + "default": "TUTORIAL_UNKNOWN", + "enum": [ + "TUTORIAL_UNKNOWN", + "TUTORIAL_LIVE_DATA_SPLIT_VIEW" + ] + } + } + } } } }, @@ -492815,6 +504953,34 @@ "description": "A description for the user. This information is public and can be seen by any authenticated user in the network.", "type": "string" }, + "email_notification_preferences": { + "description": "EmailNotificationPreferences is the message that defines the types of notifications for which the user wants to receive an email.", + "type": "object", + "properties": { + "types": { + "type": "array", + "items": { + "type": "string", + "default": "UNKNOWN", + "enum": [ + "UNKNOWN", + "API_KEY_CREATED", + "API_KEY_CHANGED", + "CLIENT_REQUESTED", + "COLLABORATOR_CHANGED", + "ENTITY_STATE_CHANGED", + "INVITATION", + "LOGIN_TOKEN", + "PASSWORD_CHANGED", + "TEMPORARY_PASSWORD", + "USER_REQUESTED", + "VALIDATE", + "SUPPORT_ACCESS_REQUESTED" + ] + } + } + } + }, "gateway_limit": { "description": "The maximum number of gateways of the user.\nThis field can only be modified by admins.", "type": "string", @@ -492916,6 +505082,109 @@ "type": "string", "format": "date-time" }, + "universal_rights": { + "description": "Universal rights are capable of restricting the user's interactions with the API, be it an admin or not.", + "type": "array", + "items": { + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "type": "string", + "default": "right_invalid", + "enum": [ + "right_invalid", + "RIGHT_USER_INFO", + "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", + "RIGHT_USER_SETTINGS_API_KEYS", + "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", + "RIGHT_USER_AUTHORIZED_CLIENTS", + "RIGHT_USER_APPLICATIONS_LIST", + "RIGHT_USER_APPLICATIONS_CREATE", + "RIGHT_USER_GATEWAYS_LIST", + "RIGHT_USER_GATEWAYS_CREATE", + "RIGHT_USER_CLIENTS_LIST", + "RIGHT_USER_CLIENTS_CREATE", + "RIGHT_USER_ORGANIZATIONS_LIST", + "RIGHT_USER_ORGANIZATIONS_CREATE", + "RIGHT_USER_NOTIFICATIONS_READ", + "RIGHT_USER_ALL", + "RIGHT_APPLICATION_INFO", + "RIGHT_APPLICATION_SETTINGS_BASIC", + "RIGHT_APPLICATION_SETTINGS_API_KEYS", + "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", + "RIGHT_APPLICATION_SETTINGS_PACKAGES", + "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", + "RIGHT_APPLICATION_DEVICES_READ", + "RIGHT_APPLICATION_DEVICES_WRITE", + "RIGHT_APPLICATION_DEVICES_READ_KEYS", + "RIGHT_APPLICATION_DEVICES_WRITE_KEYS", + "RIGHT_APPLICATION_TRAFFIC_READ", + "RIGHT_APPLICATION_TRAFFIC_UP_WRITE", + "RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE", + "RIGHT_APPLICATION_LINK", + "RIGHT_APPLICATION_ALL", + "RIGHT_CLIENT_ALL", + "RIGHT_CLIENT_INFO", + "RIGHT_CLIENT_SETTINGS_BASIC", + "RIGHT_CLIENT_SETTINGS_COLLABORATORS", + "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", + "RIGHT_GATEWAY_INFO", + "RIGHT_GATEWAY_SETTINGS_BASIC", + "RIGHT_GATEWAY_SETTINGS_API_KEYS", + "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", + "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", + "RIGHT_GATEWAY_TRAFFIC_READ", + "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", + "RIGHT_GATEWAY_LINK", + "RIGHT_GATEWAY_STATUS_READ", + "RIGHT_GATEWAY_LOCATION_READ", + "RIGHT_GATEWAY_WRITE_SECRETS", + "RIGHT_GATEWAY_READ_SECRETS", + "RIGHT_GATEWAY_ALL", + "RIGHT_ORGANIZATION_INFO", + "RIGHT_ORGANIZATION_SETTINGS_BASIC", + "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", + "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", + "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", + "RIGHT_ORGANIZATION_APPLICATIONS_LIST", + "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", + "RIGHT_ORGANIZATION_GATEWAYS_LIST", + "RIGHT_ORGANIZATION_GATEWAYS_CREATE", + "RIGHT_ORGANIZATION_CLIENTS_LIST", + "RIGHT_ORGANIZATION_CLIENTS_CREATE", + "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", + "RIGHT_ORGANIZATION_ALL", + "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", + "RIGHT_ALL" + ] + } + }, "updated_at": { "description": "When the user was last updated. This information is public and can be seen by any authenticated user in the network.", "type": "string", @@ -493138,6 +505407,23 @@ "type": "string" } } + }, + "tutorials": { + "type": "object", + "properties": { + "seen": { + "type": "array", + "items": { + "description": "Tutorial is a set of possible tutorials in the Console.", + "type": "string", + "default": "TUTORIAL_UNKNOWN", + "enum": [ + "TUTORIAL_UNKNOWN", + "TUTORIAL_LIVE_DATA_SPLIT_VIEW" + ] + } + } + } } } }, @@ -493193,6 +505479,34 @@ "description": "A description for the user. This information is public and can be seen by any authenticated user in the network.", "type": "string" }, + "email_notification_preferences": { + "description": "EmailNotificationPreferences is the message that defines the types of notifications for which the user wants to receive an email.", + "type": "object", + "properties": { + "types": { + "type": "array", + "items": { + "type": "string", + "default": "UNKNOWN", + "enum": [ + "UNKNOWN", + "API_KEY_CREATED", + "API_KEY_CHANGED", + "CLIENT_REQUESTED", + "COLLABORATOR_CHANGED", + "ENTITY_STATE_CHANGED", + "INVITATION", + "LOGIN_TOKEN", + "PASSWORD_CHANGED", + "TEMPORARY_PASSWORD", + "USER_REQUESTED", + "VALIDATE", + "SUPPORT_ACCESS_REQUESTED" + ] + } + } + } + }, "gateway_limit": { "description": "The maximum number of gateways of the user.\nThis field can only be modified by admins.", "type": "string", @@ -493294,6 +505608,109 @@ "type": "string", "format": "date-time" }, + "universal_rights": { + "description": "Universal rights are capable of restricting the user's interactions with the API, be it an admin or not.", + "type": "array", + "items": { + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "type": "string", + "default": "right_invalid", + "enum": [ + "right_invalid", + "RIGHT_USER_INFO", + "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", + "RIGHT_USER_SETTINGS_API_KEYS", + "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", + "RIGHT_USER_AUTHORIZED_CLIENTS", + "RIGHT_USER_APPLICATIONS_LIST", + "RIGHT_USER_APPLICATIONS_CREATE", + "RIGHT_USER_GATEWAYS_LIST", + "RIGHT_USER_GATEWAYS_CREATE", + "RIGHT_USER_CLIENTS_LIST", + "RIGHT_USER_CLIENTS_CREATE", + "RIGHT_USER_ORGANIZATIONS_LIST", + "RIGHT_USER_ORGANIZATIONS_CREATE", + "RIGHT_USER_NOTIFICATIONS_READ", + "RIGHT_USER_ALL", + "RIGHT_APPLICATION_INFO", + "RIGHT_APPLICATION_SETTINGS_BASIC", + "RIGHT_APPLICATION_SETTINGS_API_KEYS", + "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", + "RIGHT_APPLICATION_SETTINGS_PACKAGES", + "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", + "RIGHT_APPLICATION_DEVICES_READ", + "RIGHT_APPLICATION_DEVICES_WRITE", + "RIGHT_APPLICATION_DEVICES_READ_KEYS", + "RIGHT_APPLICATION_DEVICES_WRITE_KEYS", + "RIGHT_APPLICATION_TRAFFIC_READ", + "RIGHT_APPLICATION_TRAFFIC_UP_WRITE", + "RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE", + "RIGHT_APPLICATION_LINK", + "RIGHT_APPLICATION_ALL", + "RIGHT_CLIENT_ALL", + "RIGHT_CLIENT_INFO", + "RIGHT_CLIENT_SETTINGS_BASIC", + "RIGHT_CLIENT_SETTINGS_COLLABORATORS", + "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", + "RIGHT_GATEWAY_INFO", + "RIGHT_GATEWAY_SETTINGS_BASIC", + "RIGHT_GATEWAY_SETTINGS_API_KEYS", + "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", + "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", + "RIGHT_GATEWAY_TRAFFIC_READ", + "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", + "RIGHT_GATEWAY_LINK", + "RIGHT_GATEWAY_STATUS_READ", + "RIGHT_GATEWAY_LOCATION_READ", + "RIGHT_GATEWAY_WRITE_SECRETS", + "RIGHT_GATEWAY_READ_SECRETS", + "RIGHT_GATEWAY_ALL", + "RIGHT_ORGANIZATION_INFO", + "RIGHT_ORGANIZATION_SETTINGS_BASIC", + "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", + "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", + "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", + "RIGHT_ORGANIZATION_APPLICATIONS_LIST", + "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", + "RIGHT_ORGANIZATION_GATEWAYS_LIST", + "RIGHT_ORGANIZATION_GATEWAYS_CREATE", + "RIGHT_ORGANIZATION_CLIENTS_LIST", + "RIGHT_ORGANIZATION_CLIENTS_CREATE", + "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", + "RIGHT_ORGANIZATION_ALL", + "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", + "RIGHT_ALL" + ] + } + }, "updated_at": { "description": "When the user was last updated. This information is public and can be seen by any authenticated user in the network.", "type": "string", @@ -493411,15 +505828,18 @@ "description": "Rights that are granted to this API key.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -493437,6 +505857,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -493451,11 +505872,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -493469,6 +505892,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -493478,6 +505902,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -493555,15 +506000,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -493581,6 +506029,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -493595,11 +506044,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -493613,6 +506064,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -493622,6 +506074,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -493669,15 +506142,18 @@ "description": "Rights that are granted to this API key.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -493695,6 +506171,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -493709,11 +506186,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -493727,6 +506206,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -493736,6 +506216,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -493832,15 +506333,18 @@ "description": "Rights that are granted to this API key.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -493858,6 +506362,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -493872,11 +506377,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -493890,6 +506397,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -493899,6 +506407,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -493956,15 +506485,18 @@ "description": "Rights that are granted to this API key.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -493982,6 +506514,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -493996,11 +506529,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -494014,6 +506549,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -494023,6 +506559,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -494125,15 +506682,18 @@ "description": "Rights that are granted to this API key.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -494151,6 +506711,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -494165,11 +506726,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -494183,6 +506746,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -494192,6 +506756,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -494368,15 +506953,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -494394,6 +506982,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -494408,11 +506997,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -494426,6 +507017,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -494435,6 +507027,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -494648,15 +507261,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -494674,6 +507290,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -494688,11 +507305,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -494706,6 +507325,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -494715,6 +507335,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -496784,15 +509425,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -496810,6 +509454,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -496824,11 +509469,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -496842,6 +509489,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -496851,6 +509499,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -500634,7 +513303,54 @@ "format": "date-time" }, "last_failed_attempt_details": { - "$ref": "#/definitions/v3ErrorDetails" + "description": "Error details that are communicated over gRPC (and HTTP) APIs.\nThe messages (for translation) are stored as \"error:\u003cnamespace\u003e:\u003cname\u003e\".", + "type": "object", + "properties": { + "attributes": { + "description": "Attributes that should be filled into the message format. Any extra attributes\ncan be displayed as error details.", + "type": "object" + }, + "cause": { + "description": "The error that caused this error.", + "$ref": "#/definitions/v3ErrorDetails" + }, + "code": { + "description": "The status code of the error.", + "type": "integer", + "format": "int64" + }, + "correlation_id": { + "description": "The correlation ID of the error can be used to correlate the error to stack\ntraces the network may (or may not) store about recent errors.", + "type": "string" + }, + "details": { + "description": "The details of the error.", + "type": "array", + "items": { + "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }", + "type": "object", + "properties": { + "@type": { + "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.", + "type": "string" + } + }, + "additionalProperties": {} + } + }, + "message_format": { + "description": "The default (fallback) message format that should be used for the error.\nThis is also used if the client does not have a translation for the error.", + "type": "string" + }, + "name": { + "description": "Name of the error.", + "type": "string" + }, + "namespace": { + "description": "Namespace of the error (typically the package name in The Things Stack).", + "type": "string" + } + } } } }, @@ -500755,15 +513471,18 @@ "description": "Rights that are granted to this API key.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -500781,6 +513500,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -500795,11 +513515,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -500813,6 +513535,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -500822,6 +513545,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -507499,6 +520243,14 @@ } } }, + "TenantAccessCreateSupportTokenBody": { + "type": "object", + "properties": { + "tenant_ids": { + "type": "object" + } + } + }, "TenantAccessResendAdminValidationBody": { "type": "object", "properties": { @@ -507673,6 +520425,23 @@ } } }, + "UserConsolePreferencesTutorials": { + "type": "object", + "properties": { + "seen": { + "type": "array", + "items": { + "description": "Tutorial is a set of possible tutorials in the Console.", + "type": "string", + "default": "TUTORIAL_UNKNOWN", + "enum": [ + "TUTORIAL_UNKNOWN", + "TUTORIAL_LIVE_DATA_SPLIT_VIEW" + ] + } + } + } + }, "UserRegistryUpdatePasswordBody": { "type": "object", "properties": { @@ -511571,15 +524340,18 @@ "description": "Rights that are granted to this API key.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -511597,6 +524369,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -511611,11 +524384,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -511629,6 +524404,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -511638,6 +524414,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -511680,15 +524477,18 @@ "description": "Rights that are granted to this API key.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -511706,6 +524506,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -511720,11 +524521,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -511738,6 +524541,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -511747,6 +524551,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -512646,15 +525471,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -512672,6 +525500,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -512686,11 +525515,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -512704,6 +525535,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -512713,6 +525545,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -512759,15 +525612,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -512785,6 +525641,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -512799,11 +525656,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -512817,6 +525676,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -512826,6 +525686,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -512860,15 +525741,18 @@ "description": "Rights that are granted to this API key.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -512886,6 +525770,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -512900,11 +525785,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -512918,6 +525805,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -512927,6 +525815,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -519025,7 +531934,54 @@ "format": "date-time" }, "last_failed_attempt_details": { - "$ref": "#/definitions/v3ErrorDetails" + "description": "Error details that are communicated over gRPC (and HTTP) APIs.\nThe messages (for translation) are stored as \"error:\u003cnamespace\u003e:\u003cname\u003e\".", + "type": "object", + "properties": { + "attributes": { + "description": "Attributes that should be filled into the message format. Any extra attributes\ncan be displayed as error details.", + "type": "object" + }, + "cause": { + "description": "The error that caused this error.", + "$ref": "#/definitions/v3ErrorDetails" + }, + "code": { + "description": "The status code of the error.", + "type": "integer", + "format": "int64" + }, + "correlation_id": { + "description": "The correlation ID of the error can be used to correlate the error to stack\ntraces the network may (or may not) store about recent errors.", + "type": "string" + }, + "details": { + "description": "The details of the error.", + "type": "array", + "items": { + "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }", + "type": "object", + "properties": { + "@type": { + "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.", + "type": "string" + } + }, + "additionalProperties": {} + } + }, + "message_format": { + "description": "The default (fallback) message format that should be used for the error.\nThis is also used if the client does not have a translation for the error.", + "type": "string" + }, + "name": { + "description": "Name of the error.", + "type": "string" + }, + "namespace": { + "description": "Namespace of the error (typically the package name in The Things Stack).", + "type": "string" + } + } } } } @@ -519171,7 +532127,54 @@ "format": "date-time" }, "last_failed_attempt_details": { - "$ref": "#/definitions/v3ErrorDetails" + "description": "Error details that are communicated over gRPC (and HTTP) APIs.\nThe messages (for translation) are stored as \"error:\u003cnamespace\u003e:\u003cname\u003e\".", + "type": "object", + "properties": { + "attributes": { + "description": "Attributes that should be filled into the message format. Any extra attributes\ncan be displayed as error details.", + "type": "object" + }, + "cause": { + "description": "The error that caused this error.", + "$ref": "#/definitions/v3ErrorDetails" + }, + "code": { + "description": "The status code of the error.", + "type": "integer", + "format": "int64" + }, + "correlation_id": { + "description": "The correlation ID of the error can be used to correlate the error to stack\ntraces the network may (or may not) store about recent errors.", + "type": "string" + }, + "details": { + "description": "The details of the error.", + "type": "array", + "items": { + "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }", + "type": "object", + "properties": { + "@type": { + "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.", + "type": "string" + } + }, + "additionalProperties": {} + } + }, + "message_format": { + "description": "The default (fallback) message format that should be used for the error.\nThis is also used if the client does not have a translation for the error.", + "type": "string" + }, + "name": { + "description": "Name of the error.", + "type": "string" + }, + "namespace": { + "description": "Namespace of the error (typically the package name in The Things Stack).", + "type": "string" + } + } } } } @@ -532587,15 +545590,18 @@ "description": "Rights that are granted to this API key.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -532613,6 +545619,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -532627,11 +545634,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -532645,6 +545654,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -532654,6 +545664,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -532778,15 +545809,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -532804,6 +545838,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -532818,11 +545853,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -532836,6 +545873,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -532845,6 +545883,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -532885,15 +545944,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -532911,6 +545973,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -532925,11 +545988,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -532943,6 +546008,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -532952,6 +546018,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -532980,15 +546067,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -533006,6 +546096,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -533020,11 +546111,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -533038,6 +546131,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -533047,6 +546141,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -533112,15 +546227,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -533138,6 +546256,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -533152,11 +546271,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -533170,6 +546291,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -533179,6 +546301,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -534950,15 +548093,18 @@ "description": "Rights denotes what rights the client will have access to.\nThis information is public and can be seen by any authenticated user in the network.\nUsers that previously authorized this client will have to re-authorize the\nclient after rights are added to this list.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -534976,6 +548122,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -534990,11 +548137,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -535008,6 +548157,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -535017,6 +548167,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -535120,15 +548291,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -535146,6 +548320,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -535160,11 +548335,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -535178,6 +548355,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -535187,6 +548365,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -535345,15 +548544,18 @@ "description": "Rights denotes what rights the client will have access to.\nThis information is public and can be seen by any authenticated user in the network.\nUsers that previously authorized this client will have to re-authorize the\nclient after rights are added to this list.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -535371,6 +548573,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -535385,11 +548588,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -535403,6 +548608,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -535412,6 +548618,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -535639,15 +548866,18 @@ "description": "Rights denotes what rights the client will have access to.\nThis information is public and can be seen by any authenticated user in the network.\nUsers that previously authorized this client will have to re-authorize the\nclient after rights are added to this list.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -535665,6 +548895,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -535679,11 +548910,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -535697,6 +548930,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -535706,6 +548940,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -535919,15 +549174,18 @@ "description": "Rights denotes what rights the client will have access to.\nThis information is public and can be seen by any authenticated user in the network.\nUsers that previously authorized this client will have to re-authorize the\nclient after rights are added to this list.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -535945,6 +549203,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -535959,11 +549218,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -535977,6 +549238,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -535986,6 +549248,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -536086,15 +549369,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -536112,6 +549398,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -536126,11 +549413,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -536144,6 +549433,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -536153,6 +549443,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -536198,15 +549509,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -536224,6 +549538,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -536238,11 +549553,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -536256,6 +549573,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -536265,6 +549583,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -536766,6 +550105,1537 @@ } } }, + "v3CreateMACSettingsProfileResponse": { + "type": "object", + "properties": { + "mac_settings_profile": { + "type": "object", + "properties": { + "ids": { + "type": "object", + "properties": { + "application_ids": { + "type": "object", + "properties": { + "application_id": { + "type": "string" + } + } + }, + "profile_id": { + "description": "Profile ID.", + "type": "string" + } + } + }, + "mac_settings": { + "type": "object", + "properties": { + "adr": { + "description": "Adaptive Data Rate settings.", + "type": "object", + "properties": { + "disabled": { + "description": "Configuration options for cases in which ADR is to be disabled\ncompletely.", + "type": "object" + }, + "dynamic": { + "description": "Configuration options for dynamic ADR.", + "type": "object", + "properties": { + "channel_steering": { + "description": "EXPERIMENTAL: Channel steering settings.", + "type": "object", + "properties": { + "disabled": { + "description": "Configuration options for cases in which ADR is not supposed to steer the end device\nto another set of channels.", + "type": "object" + }, + "lora_narrow": { + "description": "Configuration options for LoRa narrow channels steering.\nThe narrow mode attempts to steer the end device towards\nusing the LoRa modulated, 125kHz bandwidth channels.", + "type": "object" + } + } + }, + "margin": { + "description": "The ADR margin (dB) tells the network server how much margin it should add in ADR requests.\nA bigger margin is less efficient, but gives a better chance of successful reception.\nIf unset, the default value from Network Server configuration will be used.", + "type": "number", + "format": "float" + }, + "max_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "max_tx_power_index": { + "description": "Maximum transmission power index.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_tx_power_index": { + "description": "Minimum transmission power index.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "overrides": { + "description": "EXPERIMENTAL: Configuration overrides.", + "type": "object", + "properties": { + "data_rate_0": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_1": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_10": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_11": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_12": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_13": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_14": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_15": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_2": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_3": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_4": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_5": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_6": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_7": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_8": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_9": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + } + } + } + } + }, + "static": { + "description": "Configuration options for static ADR.", + "type": "object", + "properties": { + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "nb_trans": { + "description": "Number of retransmissions.", + "type": "integer", + "format": "int64" + }, + "tx_power_index": { + "description": "Transmission power index to use.", + "type": "integer", + "format": "int64" + } + } + } + } + }, + "adr_margin": { + "description": "The ADR margin (dB) tells the network server how much margin it should add in ADR requests.\nA bigger margin is less efficient, but gives a better chance of successful reception.\nThis field is deprecated, use adr_settings.dynamic.margin instead.", + "type": "number", + "format": "float" + }, + "beacon_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "class_b_c_downlink_interval": { + "description": "The minimum duration passed before a network-initiated(e.g. Class B or C) downlink following an arbitrary downlink.", + "type": "string" + }, + "class_b_timeout": { + "description": "Maximum delay for the device to answer a MAC request or a confirmed downlink frame.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "class_c_timeout": { + "description": "Maximum delay for the device to answer a MAC request or a confirmed downlink frame.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "desired_adr_ack_delay_exponent": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "ADR_ACK_DELAY_1", + "enum": [ + "ADR_ACK_DELAY_1", + "ADR_ACK_DELAY_2", + "ADR_ACK_DELAY_4", + "ADR_ACK_DELAY_8", + "ADR_ACK_DELAY_16", + "ADR_ACK_DELAY_32", + "ADR_ACK_DELAY_64", + "ADR_ACK_DELAY_128", + "ADR_ACK_DELAY_256", + "ADR_ACK_DELAY_512", + "ADR_ACK_DELAY_1024", + "ADR_ACK_DELAY_2048", + "ADR_ACK_DELAY_4096", + "ADR_ACK_DELAY_8192", + "ADR_ACK_DELAY_16384", + "ADR_ACK_DELAY_32768" + ] + } + } + }, + "desired_adr_ack_limit_exponent": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "ADR_ACK_LIMIT_1", + "enum": [ + "ADR_ACK_LIMIT_1", + "ADR_ACK_LIMIT_2", + "ADR_ACK_LIMIT_4", + "ADR_ACK_LIMIT_8", + "ADR_ACK_LIMIT_16", + "ADR_ACK_LIMIT_32", + "ADR_ACK_LIMIT_64", + "ADR_ACK_LIMIT_128", + "ADR_ACK_LIMIT_256", + "ADR_ACK_LIMIT_512", + "ADR_ACK_LIMIT_1024", + "ADR_ACK_LIMIT_2048", + "ADR_ACK_LIMIT_4096", + "ADR_ACK_LIMIT_8192", + "ADR_ACK_LIMIT_16384", + "ADR_ACK_LIMIT_32768" + ] + } + } + }, + "desired_beacon_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "desired_max_duty_cycle": { + "type": "object", + "properties": { + "value": { + "description": " - DUTY_CYCLE_1: 100%.\n - DUTY_CYCLE_2: 50%.\n - DUTY_CYCLE_4: 25%.\n - DUTY_CYCLE_8: 12.5%.\n - DUTY_CYCLE_16: 6.25%.\n - DUTY_CYCLE_32: 3.125%.\n - DUTY_CYCLE_64: 1.5625%.\n - DUTY_CYCLE_128: Roughly 0.781%.\n - DUTY_CYCLE_256: Roughly 0.390%.\n - DUTY_CYCLE_512: Roughly 0.195%.\n - DUTY_CYCLE_1024: Roughly 0.098%.\n - DUTY_CYCLE_2048: Roughly 0.049%.\n - DUTY_CYCLE_4096: Roughly 0.024%.\n - DUTY_CYCLE_8192: Roughly 0.012%.\n - DUTY_CYCLE_16384: Roughly 0.006%.\n - DUTY_CYCLE_32768: Roughly 0.003%.", + "type": "string", + "default": "DUTY_CYCLE_1", + "enum": [ + "DUTY_CYCLE_1", + "DUTY_CYCLE_2", + "DUTY_CYCLE_4", + "DUTY_CYCLE_8", + "DUTY_CYCLE_16", + "DUTY_CYCLE_32", + "DUTY_CYCLE_64", + "DUTY_CYCLE_128", + "DUTY_CYCLE_256", + "DUTY_CYCLE_512", + "DUTY_CYCLE_1024", + "DUTY_CYCLE_2048", + "DUTY_CYCLE_4096", + "DUTY_CYCLE_8192", + "DUTY_CYCLE_16384", + "DUTY_CYCLE_32768" + ] + } + } + }, + "desired_max_eirp": { + "type": "object", + "properties": { + "value": { + "description": " - DEVICE_EIRP_8: 8 dBm.\n - DEVICE_EIRP_10: 10 dBm.\n - DEVICE_EIRP_12: 12 dBm.\n - DEVICE_EIRP_13: 13 dBm.\n - DEVICE_EIRP_14: 14 dBm.\n - DEVICE_EIRP_16: 16 dBm.\n - DEVICE_EIRP_18: 18 dBm.\n - DEVICE_EIRP_20: 20 dBm.\n - DEVICE_EIRP_21: 21 dBm.\n - DEVICE_EIRP_24: 24 dBm.\n - DEVICE_EIRP_26: 26 dBm.\n - DEVICE_EIRP_27: 27 dBm.\n - DEVICE_EIRP_29: 29 dBm.\n - DEVICE_EIRP_30: 30 dBm.\n - DEVICE_EIRP_33: 33 dBm.\n - DEVICE_EIRP_36: 36 dBm.", + "type": "string", + "default": "DEVICE_EIRP_8", + "enum": [ + "DEVICE_EIRP_8", + "DEVICE_EIRP_10", + "DEVICE_EIRP_12", + "DEVICE_EIRP_13", + "DEVICE_EIRP_14", + "DEVICE_EIRP_16", + "DEVICE_EIRP_18", + "DEVICE_EIRP_20", + "DEVICE_EIRP_21", + "DEVICE_EIRP_24", + "DEVICE_EIRP_26", + "DEVICE_EIRP_27", + "DEVICE_EIRP_29", + "DEVICE_EIRP_30", + "DEVICE_EIRP_33", + "DEVICE_EIRP_36" + ] + } + } + }, + "desired_ping_slot_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "desired_ping_slot_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "desired_relay": { + "description": "RelaySettings represent the settings of a relay.\nThis is used internally by the Network Server.", + "type": "object", + "properties": { + "served": { + "type": "object", + "properties": { + "always": { + "type": "object" + }, + "backoff": { + "description": "Number of wake on radio frames to be sent without an acknowledgement before sending the uplink message directly.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "dynamic": { + "type": "object", + "properties": { + "smart_enable_level": { + "type": "string", + "default": "RELAY_SMART_ENABLE_LEVEL_8", + "enum": [ + "RELAY_SMART_ENABLE_LEVEL_8", + "RELAY_SMART_ENABLE_LEVEL_16", + "RELAY_SMART_ENABLE_LEVEL_32", + "RELAY_SMART_ENABLE_LEVEL_64" + ] + } + } + }, + "end_device_controlled": { + "type": "object" + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "serving_device_id": { + "description": "End device identifier of the serving end device.", + "type": "string" + } + } + }, + "serving": { + "type": "object", + "properties": { + "cad_periodicity": { + "type": "string", + "title": "- RELAY_CAD_PERIODICITY_20_MILLISECONDS: sic", + "default": "RELAY_CAD_PERIODICITY_1_SECOND", + "enum": [ + "RELAY_CAD_PERIODICITY_1_SECOND", + "RELAY_CAD_PERIODICITY_500_MILLISECONDS", + "RELAY_CAD_PERIODICITY_250_MILLISECONDS", + "RELAY_CAD_PERIODICITY_100_MILLISECONDS", + "RELAY_CAD_PERIODICITY_50_MILLISECONDS", + "RELAY_CAD_PERIODICITY_20_MILLISECONDS" + ] + }, + "default_channel_index": { + "description": "Index of the default wake on radio channel.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "join_requests": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "notifications": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "overall": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "reset_behavior": { + "type": "string", + "default": "RELAY_RESET_LIMIT_COUNTER_ZERO", + "enum": [ + "RELAY_RESET_LIMIT_COUNTER_ZERO", + "RELAY_RESET_LIMIT_COUNTER_RELOAD_RATE", + "RELAY_RESET_LIMIT_COUNTER_MAX_VALUE", + "RELAY_RESET_LIMIT_COUNTER_NO_RESET" + ] + }, + "uplink_messages": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + } + } + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "uplink_forwarding_rules": { + "description": "Configured uplink forwarding rules.", + "type": "array", + "items": { + "type": "object", + "properties": { + "device_id": { + "description": "End device identifier of the served end device.", + "type": "string" + }, + "last_w_f_cnt": { + "description": "Last wake on radio frame counter used by the served end device.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "session_key_id": { + "description": "Session key ID of the session keys used to derive the root relay session key.", + "type": "string", + "format": "byte" + } + } + } + } + } + } + } + }, + "desired_rx1_data_rate_offset": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_OFFSET_0", + "enum": [ + "DATA_RATE_OFFSET_0", + "DATA_RATE_OFFSET_1", + "DATA_RATE_OFFSET_2", + "DATA_RATE_OFFSET_3", + "DATA_RATE_OFFSET_4", + "DATA_RATE_OFFSET_5", + "DATA_RATE_OFFSET_6", + "DATA_RATE_OFFSET_7" + ] + } + } + }, + "desired_rx1_delay": { + "type": "object", + "properties": { + "value": { + "description": " - RX_DELAY_0: 1 second.\n - RX_DELAY_1: 1 second.\n - RX_DELAY_2: 2 seconds.\n - RX_DELAY_3: 3 seconds.\n - RX_DELAY_4: 4 seconds.\n - RX_DELAY_5: 5 seconds.\n - RX_DELAY_6: 6 seconds.\n - RX_DELAY_7: 7 seconds.\n - RX_DELAY_8: 8 seconds.\n - RX_DELAY_9: 9 seconds.\n - RX_DELAY_10: 10 seconds.\n - RX_DELAY_11: 11 seconds.\n - RX_DELAY_12: 12 seconds.\n - RX_DELAY_13: 13 seconds.\n - RX_DELAY_14: 14 seconds.\n - RX_DELAY_15: 15 seconds.", + "type": "string", + "default": "RX_DELAY_0", + "enum": [ + "RX_DELAY_0", + "RX_DELAY_1", + "RX_DELAY_2", + "RX_DELAY_3", + "RX_DELAY_4", + "RX_DELAY_5", + "RX_DELAY_6", + "RX_DELAY_7", + "RX_DELAY_8", + "RX_DELAY_9", + "RX_DELAY_10", + "RX_DELAY_11", + "RX_DELAY_12", + "RX_DELAY_13", + "RX_DELAY_14", + "RX_DELAY_15" + ] + } + } + }, + "desired_rx2_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "desired_rx2_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "downlink_dwell_time": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "factory_preset_frequencies": { + "description": "List of factory-preset frequencies.\nIf unset, the default value from Network Server configuration or regional parameters specification will be used.", + "type": "array", + "items": { + "type": "string", + "format": "uint64" + } + }, + "max_duty_cycle": { + "type": "object", + "properties": { + "value": { + "description": " - DUTY_CYCLE_1: 100%.\n - DUTY_CYCLE_2: 50%.\n - DUTY_CYCLE_4: 25%.\n - DUTY_CYCLE_8: 12.5%.\n - DUTY_CYCLE_16: 6.25%.\n - DUTY_CYCLE_32: 3.125%.\n - DUTY_CYCLE_64: 1.5625%.\n - DUTY_CYCLE_128: Roughly 0.781%.\n - DUTY_CYCLE_256: Roughly 0.390%.\n - DUTY_CYCLE_512: Roughly 0.195%.\n - DUTY_CYCLE_1024: Roughly 0.098%.\n - DUTY_CYCLE_2048: Roughly 0.049%.\n - DUTY_CYCLE_4096: Roughly 0.024%.\n - DUTY_CYCLE_8192: Roughly 0.012%.\n - DUTY_CYCLE_16384: Roughly 0.006%.\n - DUTY_CYCLE_32768: Roughly 0.003%.", + "type": "string", + "default": "DUTY_CYCLE_1", + "enum": [ + "DUTY_CYCLE_1", + "DUTY_CYCLE_2", + "DUTY_CYCLE_4", + "DUTY_CYCLE_8", + "DUTY_CYCLE_16", + "DUTY_CYCLE_32", + "DUTY_CYCLE_64", + "DUTY_CYCLE_128", + "DUTY_CYCLE_256", + "DUTY_CYCLE_512", + "DUTY_CYCLE_1024", + "DUTY_CYCLE_2048", + "DUTY_CYCLE_4096", + "DUTY_CYCLE_8192", + "DUTY_CYCLE_16384", + "DUTY_CYCLE_32768" + ] + } + } + }, + "ping_slot_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "ping_slot_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "ping_slot_periodicity": { + "type": "object", + "properties": { + "value": { + "description": " - PING_EVERY_1S: Every second.\n - PING_EVERY_2S: Every 2 seconds.\n - PING_EVERY_4S: Every 4 seconds.\n - PING_EVERY_8S: Every 8 seconds.\n - PING_EVERY_16S: Every 16 seconds.\n - PING_EVERY_32S: Every 32 seconds.\n - PING_EVERY_64S: Every 64 seconds.\n - PING_EVERY_128S: Every 128 seconds.", + "type": "string", + "default": "PING_EVERY_1S", + "enum": [ + "PING_EVERY_1S", + "PING_EVERY_2S", + "PING_EVERY_4S", + "PING_EVERY_8S", + "PING_EVERY_16S", + "PING_EVERY_32S", + "PING_EVERY_64S", + "PING_EVERY_128S" + ] + } + } + }, + "relay": { + "description": "RelaySettings represent the settings of a relay.\nThis is used internally by the Network Server.", + "type": "object", + "properties": { + "served": { + "type": "object", + "properties": { + "always": { + "type": "object" + }, + "backoff": { + "description": "Number of wake on radio frames to be sent without an acknowledgement before sending the uplink message directly.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "dynamic": { + "type": "object", + "properties": { + "smart_enable_level": { + "type": "string", + "default": "RELAY_SMART_ENABLE_LEVEL_8", + "enum": [ + "RELAY_SMART_ENABLE_LEVEL_8", + "RELAY_SMART_ENABLE_LEVEL_16", + "RELAY_SMART_ENABLE_LEVEL_32", + "RELAY_SMART_ENABLE_LEVEL_64" + ] + } + } + }, + "end_device_controlled": { + "type": "object" + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "serving_device_id": { + "description": "End device identifier of the serving end device.", + "type": "string" + } + } + }, + "serving": { + "type": "object", + "properties": { + "cad_periodicity": { + "type": "string", + "title": "- RELAY_CAD_PERIODICITY_20_MILLISECONDS: sic", + "default": "RELAY_CAD_PERIODICITY_1_SECOND", + "enum": [ + "RELAY_CAD_PERIODICITY_1_SECOND", + "RELAY_CAD_PERIODICITY_500_MILLISECONDS", + "RELAY_CAD_PERIODICITY_250_MILLISECONDS", + "RELAY_CAD_PERIODICITY_100_MILLISECONDS", + "RELAY_CAD_PERIODICITY_50_MILLISECONDS", + "RELAY_CAD_PERIODICITY_20_MILLISECONDS" + ] + }, + "default_channel_index": { + "description": "Index of the default wake on radio channel.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "join_requests": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "notifications": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "overall": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "reset_behavior": { + "type": "string", + "default": "RELAY_RESET_LIMIT_COUNTER_ZERO", + "enum": [ + "RELAY_RESET_LIMIT_COUNTER_ZERO", + "RELAY_RESET_LIMIT_COUNTER_RELOAD_RATE", + "RELAY_RESET_LIMIT_COUNTER_MAX_VALUE", + "RELAY_RESET_LIMIT_COUNTER_NO_RESET" + ] + }, + "uplink_messages": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + } + } + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "uplink_forwarding_rules": { + "description": "Configured uplink forwarding rules.", + "type": "array", + "items": { + "type": "object", + "properties": { + "device_id": { + "description": "End device identifier of the served end device.", + "type": "string" + }, + "last_w_f_cnt": { + "description": "Last wake on radio frame counter used by the served end device.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "session_key_id": { + "description": "Session key ID of the session keys used to derive the root relay session key.", + "type": "string", + "format": "byte" + } + } + } + } + } + } + } + }, + "resets_f_cnt": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "rx1_data_rate_offset": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_OFFSET_0", + "enum": [ + "DATA_RATE_OFFSET_0", + "DATA_RATE_OFFSET_1", + "DATA_RATE_OFFSET_2", + "DATA_RATE_OFFSET_3", + "DATA_RATE_OFFSET_4", + "DATA_RATE_OFFSET_5", + "DATA_RATE_OFFSET_6", + "DATA_RATE_OFFSET_7" + ] + } + } + }, + "rx1_delay": { + "type": "object", + "properties": { + "value": { + "description": " - RX_DELAY_0: 1 second.\n - RX_DELAY_1: 1 second.\n - RX_DELAY_2: 2 seconds.\n - RX_DELAY_3: 3 seconds.\n - RX_DELAY_4: 4 seconds.\n - RX_DELAY_5: 5 seconds.\n - RX_DELAY_6: 6 seconds.\n - RX_DELAY_7: 7 seconds.\n - RX_DELAY_8: 8 seconds.\n - RX_DELAY_9: 9 seconds.\n - RX_DELAY_10: 10 seconds.\n - RX_DELAY_11: 11 seconds.\n - RX_DELAY_12: 12 seconds.\n - RX_DELAY_13: 13 seconds.\n - RX_DELAY_14: 14 seconds.\n - RX_DELAY_15: 15 seconds.", + "type": "string", + "default": "RX_DELAY_0", + "enum": [ + "RX_DELAY_0", + "RX_DELAY_1", + "RX_DELAY_2", + "RX_DELAY_3", + "RX_DELAY_4", + "RX_DELAY_5", + "RX_DELAY_6", + "RX_DELAY_7", + "RX_DELAY_8", + "RX_DELAY_9", + "RX_DELAY_10", + "RX_DELAY_11", + "RX_DELAY_12", + "RX_DELAY_13", + "RX_DELAY_14", + "RX_DELAY_15" + ] + } + } + }, + "rx2_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "rx2_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "schedule_downlinks": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "status_count_periodicity": { + "description": "Number of uplink messages after which a DevStatusReq MACCommand shall be sent.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "status_time_periodicity": { + "description": "The interval after which a DevStatusReq MACCommand shall be sent.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "supports_32_bit_f_cnt": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "uplink_dwell_time": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "use_adr": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + } + } + } + } + } + } + }, "v3CreateNotificationResponse": { "type": "object", "properties": { @@ -537121,6 +551991,17 @@ } } }, + "v3CreateSupportTokenResponse": { + "type": "object", + "properties": { + "login_token": { + "type": "string" + }, + "login_url": { + "type": "string" + } + } + }, "v3CreateTenantRequest": { "type": "object", "properties": { @@ -537274,6 +552155,23 @@ "type": "string" } } + }, + "tutorials": { + "type": "object", + "properties": { + "seen": { + "type": "array", + "items": { + "description": "Tutorial is a set of possible tutorials in the Console.", + "type": "string", + "default": "TUTORIAL_UNKNOWN", + "enum": [ + "TUTORIAL_UNKNOWN", + "TUTORIAL_LIVE_DATA_SPLIT_VIEW" + ] + } + } + } } } }, @@ -537329,6 +552227,34 @@ "description": "A description for the user. This information is public and can be seen by any authenticated user in the network.", "type": "string" }, + "email_notification_preferences": { + "description": "EmailNotificationPreferences is the message that defines the types of notifications for which the user wants to receive an email.", + "type": "object", + "properties": { + "types": { + "type": "array", + "items": { + "type": "string", + "default": "UNKNOWN", + "enum": [ + "UNKNOWN", + "API_KEY_CREATED", + "API_KEY_CHANGED", + "CLIENT_REQUESTED", + "COLLABORATOR_CHANGED", + "ENTITY_STATE_CHANGED", + "INVITATION", + "LOGIN_TOKEN", + "PASSWORD_CHANGED", + "TEMPORARY_PASSWORD", + "USER_REQUESTED", + "VALIDATE", + "SUPPORT_ACCESS_REQUESTED" + ] + } + } + } + }, "gateway_limit": { "description": "The maximum number of gateways of the user.\nThis field can only be modified by admins.", "type": "string", @@ -537430,6 +552356,109 @@ "type": "string", "format": "date-time" }, + "universal_rights": { + "description": "Universal rights are capable of restricting the user's interactions with the API, be it an admin or not.", + "type": "array", + "items": { + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "type": "string", + "default": "right_invalid", + "enum": [ + "right_invalid", + "RIGHT_USER_INFO", + "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", + "RIGHT_USER_SETTINGS_API_KEYS", + "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", + "RIGHT_USER_AUTHORIZED_CLIENTS", + "RIGHT_USER_APPLICATIONS_LIST", + "RIGHT_USER_APPLICATIONS_CREATE", + "RIGHT_USER_GATEWAYS_LIST", + "RIGHT_USER_GATEWAYS_CREATE", + "RIGHT_USER_CLIENTS_LIST", + "RIGHT_USER_CLIENTS_CREATE", + "RIGHT_USER_ORGANIZATIONS_LIST", + "RIGHT_USER_ORGANIZATIONS_CREATE", + "RIGHT_USER_NOTIFICATIONS_READ", + "RIGHT_USER_ALL", + "RIGHT_APPLICATION_INFO", + "RIGHT_APPLICATION_SETTINGS_BASIC", + "RIGHT_APPLICATION_SETTINGS_API_KEYS", + "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", + "RIGHT_APPLICATION_SETTINGS_PACKAGES", + "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", + "RIGHT_APPLICATION_DEVICES_READ", + "RIGHT_APPLICATION_DEVICES_WRITE", + "RIGHT_APPLICATION_DEVICES_READ_KEYS", + "RIGHT_APPLICATION_DEVICES_WRITE_KEYS", + "RIGHT_APPLICATION_TRAFFIC_READ", + "RIGHT_APPLICATION_TRAFFIC_UP_WRITE", + "RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE", + "RIGHT_APPLICATION_LINK", + "RIGHT_APPLICATION_ALL", + "RIGHT_CLIENT_ALL", + "RIGHT_CLIENT_INFO", + "RIGHT_CLIENT_SETTINGS_BASIC", + "RIGHT_CLIENT_SETTINGS_COLLABORATORS", + "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", + "RIGHT_GATEWAY_INFO", + "RIGHT_GATEWAY_SETTINGS_BASIC", + "RIGHT_GATEWAY_SETTINGS_API_KEYS", + "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", + "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", + "RIGHT_GATEWAY_TRAFFIC_READ", + "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", + "RIGHT_GATEWAY_LINK", + "RIGHT_GATEWAY_STATUS_READ", + "RIGHT_GATEWAY_LOCATION_READ", + "RIGHT_GATEWAY_WRITE_SECRETS", + "RIGHT_GATEWAY_READ_SECRETS", + "RIGHT_GATEWAY_ALL", + "RIGHT_ORGANIZATION_INFO", + "RIGHT_ORGANIZATION_SETTINGS_BASIC", + "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", + "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", + "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", + "RIGHT_ORGANIZATION_APPLICATIONS_LIST", + "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", + "RIGHT_ORGANIZATION_GATEWAYS_LIST", + "RIGHT_ORGANIZATION_GATEWAYS_CREATE", + "RIGHT_ORGANIZATION_CLIENTS_LIST", + "RIGHT_ORGANIZATION_CLIENTS_CREATE", + "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", + "RIGHT_ORGANIZATION_ALL", + "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", + "RIGHT_ALL" + ] + } + }, "updated_at": { "description": "When the user was last updated. This information is public and can be seen by any authenticated user in the network.", "type": "string", @@ -538165,286 +553194,331 @@ "type": "string", "format": "date-time" }, - "description": { - "type": "string" - }, - "ids": { - "type": "object", - "properties": { - "tenant_id": { - "type": "string" - } - } - }, - "max_applications": { - "description": "If set, restricts the maximum number of applications that can be created.", - "type": "string", - "format": "uint64" - }, - "max_clients": { - "description": "If set, restricts the maximum number of clients that can be created.", - "type": "string", - "format": "uint64" - }, - "max_end_devices": { - "description": "If set, restricts the maximum number of end_devices that can be created.", - "type": "string", - "format": "uint64" - }, - "max_gateways": { - "description": "If set, restricts the maximum number of gateways that can be created.", - "type": "string", - "format": "uint64" - }, - "max_organizations": { - "description": "If set, restricts the maximum number of organizations that can be created.", - "type": "string", - "format": "uint64" - }, - "max_users": { - "description": "If set, restricts the maximum number of users that can be created.", - "type": "string", - "format": "uint64" - }, - "name": { - "type": "string" - }, - "state": { - "description": "State enum defines states that an entity can be in.\n\n - STATE_REQUESTED: Denotes that the entity has been requested and is pending review by an admin.\n - STATE_APPROVED: Denotes that the entity has been reviewed and approved by an admin.\n - STATE_REJECTED: Denotes that the entity has been reviewed and rejected by an admin.\n - STATE_FLAGGED: Denotes that the entity has been flagged and is pending review by an admin.\n - STATE_SUSPENDED: Denotes that the entity has been reviewed and suspended by an admin.", - "type": "string", - "default": "STATE_REQUESTED", - "enum": [ - "STATE_REQUESTED", - "STATE_APPROVED", - "STATE_REJECTED", - "STATE_FLAGGED", - "STATE_SUSPENDED" - ] - }, - "state_description": { - "description": "A description for the state field.\nThis field can only be modified by admins, and should typically only be updated\nwhen also updating `state`.", - "type": "string" - }, - "updated_at": { + "description": { + "type": "string" + }, + "ids": { + "type": "object", + "properties": { + "tenant_id": { + "type": "string" + } + } + }, + "max_applications": { + "description": "If set, restricts the maximum number of applications that can be created.", + "type": "string", + "format": "uint64" + }, + "max_clients": { + "description": "If set, restricts the maximum number of clients that can be created.", + "type": "string", + "format": "uint64" + }, + "max_end_devices": { + "description": "If set, restricts the maximum number of end_devices that can be created.", + "type": "string", + "format": "uint64" + }, + "max_gateways": { + "description": "If set, restricts the maximum number of gateways that can be created.", + "type": "string", + "format": "uint64" + }, + "max_organizations": { + "description": "If set, restricts the maximum number of organizations that can be created.", + "type": "string", + "format": "uint64" + }, + "max_users": { + "description": "If set, restricts the maximum number of users that can be created.", + "type": "string", + "format": "uint64" + }, + "name": { + "type": "string" + }, + "state": { + "description": "State enum defines states that an entity can be in.\n\n - STATE_REQUESTED: Denotes that the entity has been requested and is pending review by an admin.\n - STATE_APPROVED: Denotes that the entity has been reviewed and approved by an admin.\n - STATE_REJECTED: Denotes that the entity has been reviewed and rejected by an admin.\n - STATE_FLAGGED: Denotes that the entity has been flagged and is pending review by an admin.\n - STATE_SUSPENDED: Denotes that the entity has been reviewed and suspended by an admin.", + "type": "string", + "default": "STATE_REQUESTED", + "enum": [ + "STATE_REQUESTED", + "STATE_APPROVED", + "STATE_REJECTED", + "STATE_FLAGGED", + "STATE_SUSPENDED" + ] + }, + "state_description": { + "description": "A description for the state field.\nThis field can only be modified by admins, and should typically only be updated\nwhen also updating `state`.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + } + } + }, + "v3CreateUserRequest": { + "type": "object", + "properties": { + "invitation_token": { + "description": "The invitation token that was sent to the user (some networks require an invitation in order to register new users).", + "type": "string" + }, + "user": { + "description": "User is the message that defines a user on the network.", + "type": "object", + "properties": { + "admin": { + "description": "This user is an admin.\nThis information is public and can be seen by any authenticated user in the network.\nThis field can only be modified by other admins.", + "type": "boolean" + }, + "application_limit": { + "description": "The maximum number of applications of the user.\nThis field can only be modified by admins.", + "type": "string", + "format": "uint64" + }, + "attributes": { + "description": "Key-value attributes for this users. Typically used for storing integration-specific data.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "client_limit": { + "description": "The maximum number of clients of the user.\nThis field can only be modified by admins.", + "type": "string", + "format": "uint64" + }, + "console_preferences": { + "description": "UserConsolePreferences is the message that defines the user preferences for the Console.", + "type": "object", + "properties": { + "console_theme": { + "description": "ConsoleTheme is the theme of the Console.\n\n - CONSOLE_THEME_SYSTEM: The user prefers the system mode.\n - CONSOLE_THEME_LIGHT: The user prefers the light mode.\n - CONSOLE_THEME_DARK: The user prefers the dark mode.", + "type": "string", + "default": "CONSOLE_THEME_SYSTEM", + "enum": [ + "CONSOLE_THEME_SYSTEM", + "CONSOLE_THEME_LIGHT", + "CONSOLE_THEME_DARK" + ] + }, + "dashboard_layouts": { + "type": "object", + "properties": { + "api_key": { + "description": "DashboardLayout is a set of possible layout values to be used in the Console.", + "type": "string", + "default": "DASHBOARD_LAYOUT_TABLE", + "enum": [ + "DASHBOARD_LAYOUT_TABLE", + "DASHBOARD_LAYOUT_LIST", + "DASHBOARD_LAYOUT_GRID" + ] + }, + "application": { + "description": "DashboardLayout is a set of possible layout values to be used in the Console.", + "type": "string", + "default": "DASHBOARD_LAYOUT_TABLE", + "enum": [ + "DASHBOARD_LAYOUT_TABLE", + "DASHBOARD_LAYOUT_LIST", + "DASHBOARD_LAYOUT_GRID" + ] + }, + "collaborator": { + "description": "DashboardLayout is a set of possible layout values to be used in the Console.", + "type": "string", + "default": "DASHBOARD_LAYOUT_TABLE", + "enum": [ + "DASHBOARD_LAYOUT_TABLE", + "DASHBOARD_LAYOUT_LIST", + "DASHBOARD_LAYOUT_GRID" + ] + }, + "end_device": { + "description": "DashboardLayout is a set of possible layout values to be used in the Console.", + "type": "string", + "default": "DASHBOARD_LAYOUT_TABLE", + "enum": [ + "DASHBOARD_LAYOUT_TABLE", + "DASHBOARD_LAYOUT_LIST", + "DASHBOARD_LAYOUT_GRID" + ] + }, + "gateway": { + "description": "DashboardLayout is a set of possible layout values to be used in the Console.", + "type": "string", + "default": "DASHBOARD_LAYOUT_TABLE", + "enum": [ + "DASHBOARD_LAYOUT_TABLE", + "DASHBOARD_LAYOUT_LIST", + "DASHBOARD_LAYOUT_GRID" + ] + }, + "organization": { + "description": "DashboardLayout is a set of possible layout values to be used in the Console.", + "type": "string", + "default": "DASHBOARD_LAYOUT_TABLE", + "enum": [ + "DASHBOARD_LAYOUT_TABLE", + "DASHBOARD_LAYOUT_LIST", + "DASHBOARD_LAYOUT_GRID" + ] + }, + "overview": { + "description": "DashboardLayout is a set of possible layout values to be used in the Console.", + "type": "string", + "default": "DASHBOARD_LAYOUT_TABLE", + "enum": [ + "DASHBOARD_LAYOUT_TABLE", + "DASHBOARD_LAYOUT_LIST", + "DASHBOARD_LAYOUT_GRID" + ] + }, + "user": { + "description": "DashboardLayout is a set of possible layout values to be used in the Console.", + "type": "string", + "default": "DASHBOARD_LAYOUT_TABLE", + "enum": [ + "DASHBOARD_LAYOUT_TABLE", + "DASHBOARD_LAYOUT_LIST", + "DASHBOARD_LAYOUT_GRID" + ] + } + } + }, + "sort_by": { + "description": "SortBy defines the field to which the Console will sort the display of entities.", + "type": "object", + "properties": { + "api_key": { + "type": "string" + }, + "application": { + "type": "string" + }, + "collaborator": { + "type": "string" + }, + "end_device": { + "type": "string" + }, + "gateway": { + "type": "string" + }, + "organization": { + "type": "string" + }, + "user": { + "type": "string" + } + } + }, + "tutorials": { + "type": "object", + "properties": { + "seen": { + "type": "array", + "items": { + "description": "Tutorial is a set of possible tutorials in the Console.", + "type": "string", + "default": "TUTORIAL_UNKNOWN", + "enum": [ + "TUTORIAL_UNKNOWN", + "TUTORIAL_LIVE_DATA_SPLIT_VIEW" + ] + } + } + } + } + } + }, + "contact_info": { + "description": "Contact information for this user. Typically used to indicate who to contact with security/billing questions about the user.\nThis field is deprecated.", + "type": "array", + "items": { + "type": "object", + "properties": { + "contact_method": { + "type": "string", + "default": "CONTACT_METHOD_OTHER", + "enum": [ + "CONTACT_METHOD_OTHER", + "CONTACT_METHOD_EMAIL", + "CONTACT_METHOD_PHONE" + ] + }, + "contact_type": { + "type": "string", + "default": "CONTACT_TYPE_OTHER", + "enum": [ + "CONTACT_TYPE_OTHER", + "CONTACT_TYPE_ABUSE", + "CONTACT_TYPE_BILLING", + "CONTACT_TYPE_TECHNICAL" + ] + }, + "public": { + "type": "boolean" + }, + "validated_at": { + "type": "string", + "format": "date-time" + }, + "value": { + "type": "string" + } + } + } + }, + "created_at": { + "description": "When the user was created. This information is public and can be seen by any authenticated user in the network.", + "type": "string", + "format": "date-time" + }, + "deleted_at": { + "description": "When the user was deleted. This information is public and can be seen by any authenticated user in the network.", "type": "string", "format": "date-time" - } - } - } - } - }, - "v3CreateUserRequest": { - "type": "object", - "properties": { - "invitation_token": { - "description": "The invitation token that was sent to the user (some networks require an invitation in order to register new users).", - "type": "string" - }, - "user": { - "description": "User is the message that defines a user on the network.", - "type": "object", - "properties": { - "admin": { - "description": "This user is an admin.\nThis information is public and can be seen by any authenticated user in the network.\nThis field can only be modified by other admins.", - "type": "boolean" - }, - "application_limit": { - "description": "The maximum number of applications of the user.\nThis field can only be modified by admins.", - "type": "string", - "format": "uint64" - }, - "attributes": { - "description": "Key-value attributes for this users. Typically used for storing integration-specific data.", - "type": "object", - "additionalProperties": { - "type": "string" - } }, - "client_limit": { - "description": "The maximum number of clients of the user.\nThis field can only be modified by admins.", - "type": "string", - "format": "uint64" + "description": { + "description": "A description for the user. This information is public and can be seen by any authenticated user in the network.", + "type": "string" }, - "console_preferences": { - "description": "UserConsolePreferences is the message that defines the user preferences for the Console.", + "email_notification_preferences": { + "description": "EmailNotificationPreferences is the message that defines the types of notifications for which the user wants to receive an email.", "type": "object", "properties": { - "console_theme": { - "description": "ConsoleTheme is the theme of the Console.\n\n - CONSOLE_THEME_SYSTEM: The user prefers the system mode.\n - CONSOLE_THEME_LIGHT: The user prefers the light mode.\n - CONSOLE_THEME_DARK: The user prefers the dark mode.", - "type": "string", - "default": "CONSOLE_THEME_SYSTEM", - "enum": [ - "CONSOLE_THEME_SYSTEM", - "CONSOLE_THEME_LIGHT", - "CONSOLE_THEME_DARK" - ] - }, - "dashboard_layouts": { - "type": "object", - "properties": { - "api_key": { - "description": "DashboardLayout is a set of possible layout values to be used in the Console.", - "type": "string", - "default": "DASHBOARD_LAYOUT_TABLE", - "enum": [ - "DASHBOARD_LAYOUT_TABLE", - "DASHBOARD_LAYOUT_LIST", - "DASHBOARD_LAYOUT_GRID" - ] - }, - "application": { - "description": "DashboardLayout is a set of possible layout values to be used in the Console.", - "type": "string", - "default": "DASHBOARD_LAYOUT_TABLE", - "enum": [ - "DASHBOARD_LAYOUT_TABLE", - "DASHBOARD_LAYOUT_LIST", - "DASHBOARD_LAYOUT_GRID" - ] - }, - "collaborator": { - "description": "DashboardLayout is a set of possible layout values to be used in the Console.", - "type": "string", - "default": "DASHBOARD_LAYOUT_TABLE", - "enum": [ - "DASHBOARD_LAYOUT_TABLE", - "DASHBOARD_LAYOUT_LIST", - "DASHBOARD_LAYOUT_GRID" - ] - }, - "end_device": { - "description": "DashboardLayout is a set of possible layout values to be used in the Console.", - "type": "string", - "default": "DASHBOARD_LAYOUT_TABLE", - "enum": [ - "DASHBOARD_LAYOUT_TABLE", - "DASHBOARD_LAYOUT_LIST", - "DASHBOARD_LAYOUT_GRID" - ] - }, - "gateway": { - "description": "DashboardLayout is a set of possible layout values to be used in the Console.", - "type": "string", - "default": "DASHBOARD_LAYOUT_TABLE", - "enum": [ - "DASHBOARD_LAYOUT_TABLE", - "DASHBOARD_LAYOUT_LIST", - "DASHBOARD_LAYOUT_GRID" - ] - }, - "organization": { - "description": "DashboardLayout is a set of possible layout values to be used in the Console.", - "type": "string", - "default": "DASHBOARD_LAYOUT_TABLE", - "enum": [ - "DASHBOARD_LAYOUT_TABLE", - "DASHBOARD_LAYOUT_LIST", - "DASHBOARD_LAYOUT_GRID" - ] - }, - "overview": { - "description": "DashboardLayout is a set of possible layout values to be used in the Console.", - "type": "string", - "default": "DASHBOARD_LAYOUT_TABLE", - "enum": [ - "DASHBOARD_LAYOUT_TABLE", - "DASHBOARD_LAYOUT_LIST", - "DASHBOARD_LAYOUT_GRID" - ] - }, - "user": { - "description": "DashboardLayout is a set of possible layout values to be used in the Console.", - "type": "string", - "default": "DASHBOARD_LAYOUT_TABLE", - "enum": [ - "DASHBOARD_LAYOUT_TABLE", - "DASHBOARD_LAYOUT_LIST", - "DASHBOARD_LAYOUT_GRID" - ] - } - } - }, - "sort_by": { - "description": "SortBy defines the field to which the Console will sort the display of entities.", - "type": "object", - "properties": { - "api_key": { - "type": "string" - }, - "application": { - "type": "string" - }, - "collaborator": { - "type": "string" - }, - "end_device": { - "type": "string" - }, - "gateway": { - "type": "string" - }, - "organization": { - "type": "string" - }, - "user": { - "type": "string" - } - } - } - } - }, - "contact_info": { - "description": "Contact information for this user. Typically used to indicate who to contact with security/billing questions about the user.\nThis field is deprecated.", - "type": "array", - "items": { - "type": "object", - "properties": { - "contact_method": { + "types": { + "type": "array", + "items": { "type": "string", - "default": "CONTACT_METHOD_OTHER", + "default": "UNKNOWN", "enum": [ - "CONTACT_METHOD_OTHER", - "CONTACT_METHOD_EMAIL", - "CONTACT_METHOD_PHONE" + "UNKNOWN", + "API_KEY_CREATED", + "API_KEY_CHANGED", + "CLIENT_REQUESTED", + "COLLABORATOR_CHANGED", + "ENTITY_STATE_CHANGED", + "INVITATION", + "LOGIN_TOKEN", + "PASSWORD_CHANGED", + "TEMPORARY_PASSWORD", + "USER_REQUESTED", + "VALIDATE", + "SUPPORT_ACCESS_REQUESTED" ] - }, - "contact_type": { - "type": "string", - "default": "CONTACT_TYPE_OTHER", - "enum": [ - "CONTACT_TYPE_OTHER", - "CONTACT_TYPE_ABUSE", - "CONTACT_TYPE_BILLING", - "CONTACT_TYPE_TECHNICAL" - ] - }, - "public": { - "type": "boolean" - }, - "validated_at": { - "type": "string", - "format": "date-time" - }, - "value": { - "type": "string" } } } }, - "created_at": { - "description": "When the user was created. This information is public and can be seen by any authenticated user in the network.", - "type": "string", - "format": "date-time" - }, - "deleted_at": { - "description": "When the user was deleted. This information is public and can be seen by any authenticated user in the network.", - "type": "string", - "format": "date-time" - }, - "description": { - "description": "A description for the user. This information is public and can be seen by any authenticated user in the network.", - "type": "string" - }, "gateway_limit": { "description": "The maximum number of gateways of the user.\nThis field can only be modified by admins.", "type": "string", @@ -538546,6 +553620,109 @@ "type": "string", "format": "date-time" }, + "universal_rights": { + "description": "Universal rights are capable of restricting the user's interactions with the API, be it an admin or not.", + "type": "array", + "items": { + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "type": "string", + "default": "right_invalid", + "enum": [ + "right_invalid", + "RIGHT_USER_INFO", + "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", + "RIGHT_USER_SETTINGS_API_KEYS", + "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", + "RIGHT_USER_AUTHORIZED_CLIENTS", + "RIGHT_USER_APPLICATIONS_LIST", + "RIGHT_USER_APPLICATIONS_CREATE", + "RIGHT_USER_GATEWAYS_LIST", + "RIGHT_USER_GATEWAYS_CREATE", + "RIGHT_USER_CLIENTS_LIST", + "RIGHT_USER_CLIENTS_CREATE", + "RIGHT_USER_ORGANIZATIONS_LIST", + "RIGHT_USER_ORGANIZATIONS_CREATE", + "RIGHT_USER_NOTIFICATIONS_READ", + "RIGHT_USER_ALL", + "RIGHT_APPLICATION_INFO", + "RIGHT_APPLICATION_SETTINGS_BASIC", + "RIGHT_APPLICATION_SETTINGS_API_KEYS", + "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", + "RIGHT_APPLICATION_SETTINGS_PACKAGES", + "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", + "RIGHT_APPLICATION_DEVICES_READ", + "RIGHT_APPLICATION_DEVICES_WRITE", + "RIGHT_APPLICATION_DEVICES_READ_KEYS", + "RIGHT_APPLICATION_DEVICES_WRITE_KEYS", + "RIGHT_APPLICATION_TRAFFIC_READ", + "RIGHT_APPLICATION_TRAFFIC_UP_WRITE", + "RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE", + "RIGHT_APPLICATION_LINK", + "RIGHT_APPLICATION_ALL", + "RIGHT_CLIENT_ALL", + "RIGHT_CLIENT_INFO", + "RIGHT_CLIENT_SETTINGS_BASIC", + "RIGHT_CLIENT_SETTINGS_COLLABORATORS", + "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", + "RIGHT_GATEWAY_INFO", + "RIGHT_GATEWAY_SETTINGS_BASIC", + "RIGHT_GATEWAY_SETTINGS_API_KEYS", + "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", + "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", + "RIGHT_GATEWAY_TRAFFIC_READ", + "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", + "RIGHT_GATEWAY_LINK", + "RIGHT_GATEWAY_STATUS_READ", + "RIGHT_GATEWAY_LOCATION_READ", + "RIGHT_GATEWAY_WRITE_SECRETS", + "RIGHT_GATEWAY_READ_SECRETS", + "RIGHT_GATEWAY_ALL", + "RIGHT_ORGANIZATION_INFO", + "RIGHT_ORGANIZATION_SETTINGS_BASIC", + "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", + "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", + "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", + "RIGHT_ORGANIZATION_APPLICATIONS_LIST", + "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", + "RIGHT_ORGANIZATION_GATEWAYS_LIST", + "RIGHT_ORGANIZATION_GATEWAYS_CREATE", + "RIGHT_ORGANIZATION_CLIENTS_LIST", + "RIGHT_ORGANIZATION_CLIENTS_CREATE", + "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", + "RIGHT_ORGANIZATION_ALL", + "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", + "RIGHT_ALL" + ] + } + }, "updated_at": { "description": "When the user was last updated. This information is public and can be seen by any authenticated user in the network.", "type": "string", @@ -539551,6 +554728,9 @@ } } }, + "v3DeleteMACSettingsProfileResponse": { + "type": "object" + }, "v3DeleteRelayResponse": { "type": "object" }, @@ -539666,6 +554846,34 @@ "DOWNLINK_PATH_CONSTRAINT_NEVER" ] }, + "v3EmailNotificationPreferences": { + "description": "EmailNotificationPreferences is the message that defines the types of notifications for which the user wants to receive an email.", + "type": "object", + "properties": { + "types": { + "type": "array", + "items": { + "type": "string", + "default": "UNKNOWN", + "enum": [ + "UNKNOWN", + "API_KEY_CREATED", + "API_KEY_CHANGED", + "CLIENT_REQUESTED", + "COLLABORATOR_CHANGED", + "ENTITY_STATE_CHANGED", + "INVITATION", + "LOGIN_TOKEN", + "PASSWORD_CHANGED", + "TEMPORARY_PASSWORD", + "USER_REQUESTED", + "VALIDATE", + "SUPPORT_ACCESS_REQUESTED" + ] + } + } + } + }, "v3EmailValidation": { "type": "object", "properties": { @@ -601942,15 +617150,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -601968,6 +617179,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -601982,11 +617194,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -602000,6 +617214,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -602009,6 +617224,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -602343,15 +617579,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -602369,6 +617608,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -602383,11 +617623,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -602401,6 +617643,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -602410,6 +617653,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -602853,15 +618117,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -602879,6 +618146,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -602893,11 +618161,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -602911,6 +618181,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -602920,6 +618191,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -602963,15 +618255,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -602989,6 +618284,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -603003,11 +618299,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -603021,6 +618319,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -603030,6 +618329,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -603075,15 +618395,18 @@ "description": "Rights that are granted to this API key.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -603101,6 +618424,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -603115,11 +618439,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -603133,6 +618459,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -603142,6 +618469,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -618249,15 +633597,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -618275,6 +633626,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -618289,11 +633641,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -618307,6 +633661,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -618316,6 +633671,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -618697,6 +634073,1537 @@ } } }, + "v3GetMACSettingsProfileResponse": { + "type": "object", + "properties": { + "mac_settings_profile": { + "type": "object", + "properties": { + "ids": { + "type": "object", + "properties": { + "application_ids": { + "type": "object", + "properties": { + "application_id": { + "type": "string" + } + } + }, + "profile_id": { + "description": "Profile ID.", + "type": "string" + } + } + }, + "mac_settings": { + "type": "object", + "properties": { + "adr": { + "description": "Adaptive Data Rate settings.", + "type": "object", + "properties": { + "disabled": { + "description": "Configuration options for cases in which ADR is to be disabled\ncompletely.", + "type": "object" + }, + "dynamic": { + "description": "Configuration options for dynamic ADR.", + "type": "object", + "properties": { + "channel_steering": { + "description": "EXPERIMENTAL: Channel steering settings.", + "type": "object", + "properties": { + "disabled": { + "description": "Configuration options for cases in which ADR is not supposed to steer the end device\nto another set of channels.", + "type": "object" + }, + "lora_narrow": { + "description": "Configuration options for LoRa narrow channels steering.\nThe narrow mode attempts to steer the end device towards\nusing the LoRa modulated, 125kHz bandwidth channels.", + "type": "object" + } + } + }, + "margin": { + "description": "The ADR margin (dB) tells the network server how much margin it should add in ADR requests.\nA bigger margin is less efficient, but gives a better chance of successful reception.\nIf unset, the default value from Network Server configuration will be used.", + "type": "number", + "format": "float" + }, + "max_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "max_tx_power_index": { + "description": "Maximum transmission power index.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_tx_power_index": { + "description": "Minimum transmission power index.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "overrides": { + "description": "EXPERIMENTAL: Configuration overrides.", + "type": "object", + "properties": { + "data_rate_0": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_1": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_10": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_11": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_12": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_13": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_14": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_15": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_2": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_3": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_4": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_5": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_6": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_7": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_8": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_9": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + } + } + } + } + }, + "static": { + "description": "Configuration options for static ADR.", + "type": "object", + "properties": { + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "nb_trans": { + "description": "Number of retransmissions.", + "type": "integer", + "format": "int64" + }, + "tx_power_index": { + "description": "Transmission power index to use.", + "type": "integer", + "format": "int64" + } + } + } + } + }, + "adr_margin": { + "description": "The ADR margin (dB) tells the network server how much margin it should add in ADR requests.\nA bigger margin is less efficient, but gives a better chance of successful reception.\nThis field is deprecated, use adr_settings.dynamic.margin instead.", + "type": "number", + "format": "float" + }, + "beacon_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "class_b_c_downlink_interval": { + "description": "The minimum duration passed before a network-initiated(e.g. Class B or C) downlink following an arbitrary downlink.", + "type": "string" + }, + "class_b_timeout": { + "description": "Maximum delay for the device to answer a MAC request or a confirmed downlink frame.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "class_c_timeout": { + "description": "Maximum delay for the device to answer a MAC request or a confirmed downlink frame.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "desired_adr_ack_delay_exponent": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "ADR_ACK_DELAY_1", + "enum": [ + "ADR_ACK_DELAY_1", + "ADR_ACK_DELAY_2", + "ADR_ACK_DELAY_4", + "ADR_ACK_DELAY_8", + "ADR_ACK_DELAY_16", + "ADR_ACK_DELAY_32", + "ADR_ACK_DELAY_64", + "ADR_ACK_DELAY_128", + "ADR_ACK_DELAY_256", + "ADR_ACK_DELAY_512", + "ADR_ACK_DELAY_1024", + "ADR_ACK_DELAY_2048", + "ADR_ACK_DELAY_4096", + "ADR_ACK_DELAY_8192", + "ADR_ACK_DELAY_16384", + "ADR_ACK_DELAY_32768" + ] + } + } + }, + "desired_adr_ack_limit_exponent": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "ADR_ACK_LIMIT_1", + "enum": [ + "ADR_ACK_LIMIT_1", + "ADR_ACK_LIMIT_2", + "ADR_ACK_LIMIT_4", + "ADR_ACK_LIMIT_8", + "ADR_ACK_LIMIT_16", + "ADR_ACK_LIMIT_32", + "ADR_ACK_LIMIT_64", + "ADR_ACK_LIMIT_128", + "ADR_ACK_LIMIT_256", + "ADR_ACK_LIMIT_512", + "ADR_ACK_LIMIT_1024", + "ADR_ACK_LIMIT_2048", + "ADR_ACK_LIMIT_4096", + "ADR_ACK_LIMIT_8192", + "ADR_ACK_LIMIT_16384", + "ADR_ACK_LIMIT_32768" + ] + } + } + }, + "desired_beacon_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "desired_max_duty_cycle": { + "type": "object", + "properties": { + "value": { + "description": " - DUTY_CYCLE_1: 100%.\n - DUTY_CYCLE_2: 50%.\n - DUTY_CYCLE_4: 25%.\n - DUTY_CYCLE_8: 12.5%.\n - DUTY_CYCLE_16: 6.25%.\n - DUTY_CYCLE_32: 3.125%.\n - DUTY_CYCLE_64: 1.5625%.\n - DUTY_CYCLE_128: Roughly 0.781%.\n - DUTY_CYCLE_256: Roughly 0.390%.\n - DUTY_CYCLE_512: Roughly 0.195%.\n - DUTY_CYCLE_1024: Roughly 0.098%.\n - DUTY_CYCLE_2048: Roughly 0.049%.\n - DUTY_CYCLE_4096: Roughly 0.024%.\n - DUTY_CYCLE_8192: Roughly 0.012%.\n - DUTY_CYCLE_16384: Roughly 0.006%.\n - DUTY_CYCLE_32768: Roughly 0.003%.", + "type": "string", + "default": "DUTY_CYCLE_1", + "enum": [ + "DUTY_CYCLE_1", + "DUTY_CYCLE_2", + "DUTY_CYCLE_4", + "DUTY_CYCLE_8", + "DUTY_CYCLE_16", + "DUTY_CYCLE_32", + "DUTY_CYCLE_64", + "DUTY_CYCLE_128", + "DUTY_CYCLE_256", + "DUTY_CYCLE_512", + "DUTY_CYCLE_1024", + "DUTY_CYCLE_2048", + "DUTY_CYCLE_4096", + "DUTY_CYCLE_8192", + "DUTY_CYCLE_16384", + "DUTY_CYCLE_32768" + ] + } + } + }, + "desired_max_eirp": { + "type": "object", + "properties": { + "value": { + "description": " - DEVICE_EIRP_8: 8 dBm.\n - DEVICE_EIRP_10: 10 dBm.\n - DEVICE_EIRP_12: 12 dBm.\n - DEVICE_EIRP_13: 13 dBm.\n - DEVICE_EIRP_14: 14 dBm.\n - DEVICE_EIRP_16: 16 dBm.\n - DEVICE_EIRP_18: 18 dBm.\n - DEVICE_EIRP_20: 20 dBm.\n - DEVICE_EIRP_21: 21 dBm.\n - DEVICE_EIRP_24: 24 dBm.\n - DEVICE_EIRP_26: 26 dBm.\n - DEVICE_EIRP_27: 27 dBm.\n - DEVICE_EIRP_29: 29 dBm.\n - DEVICE_EIRP_30: 30 dBm.\n - DEVICE_EIRP_33: 33 dBm.\n - DEVICE_EIRP_36: 36 dBm.", + "type": "string", + "default": "DEVICE_EIRP_8", + "enum": [ + "DEVICE_EIRP_8", + "DEVICE_EIRP_10", + "DEVICE_EIRP_12", + "DEVICE_EIRP_13", + "DEVICE_EIRP_14", + "DEVICE_EIRP_16", + "DEVICE_EIRP_18", + "DEVICE_EIRP_20", + "DEVICE_EIRP_21", + "DEVICE_EIRP_24", + "DEVICE_EIRP_26", + "DEVICE_EIRP_27", + "DEVICE_EIRP_29", + "DEVICE_EIRP_30", + "DEVICE_EIRP_33", + "DEVICE_EIRP_36" + ] + } + } + }, + "desired_ping_slot_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "desired_ping_slot_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "desired_relay": { + "description": "RelaySettings represent the settings of a relay.\nThis is used internally by the Network Server.", + "type": "object", + "properties": { + "served": { + "type": "object", + "properties": { + "always": { + "type": "object" + }, + "backoff": { + "description": "Number of wake on radio frames to be sent without an acknowledgement before sending the uplink message directly.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "dynamic": { + "type": "object", + "properties": { + "smart_enable_level": { + "type": "string", + "default": "RELAY_SMART_ENABLE_LEVEL_8", + "enum": [ + "RELAY_SMART_ENABLE_LEVEL_8", + "RELAY_SMART_ENABLE_LEVEL_16", + "RELAY_SMART_ENABLE_LEVEL_32", + "RELAY_SMART_ENABLE_LEVEL_64" + ] + } + } + }, + "end_device_controlled": { + "type": "object" + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "serving_device_id": { + "description": "End device identifier of the serving end device.", + "type": "string" + } + } + }, + "serving": { + "type": "object", + "properties": { + "cad_periodicity": { + "type": "string", + "title": "- RELAY_CAD_PERIODICITY_20_MILLISECONDS: sic", + "default": "RELAY_CAD_PERIODICITY_1_SECOND", + "enum": [ + "RELAY_CAD_PERIODICITY_1_SECOND", + "RELAY_CAD_PERIODICITY_500_MILLISECONDS", + "RELAY_CAD_PERIODICITY_250_MILLISECONDS", + "RELAY_CAD_PERIODICITY_100_MILLISECONDS", + "RELAY_CAD_PERIODICITY_50_MILLISECONDS", + "RELAY_CAD_PERIODICITY_20_MILLISECONDS" + ] + }, + "default_channel_index": { + "description": "Index of the default wake on radio channel.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "join_requests": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "notifications": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "overall": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "reset_behavior": { + "type": "string", + "default": "RELAY_RESET_LIMIT_COUNTER_ZERO", + "enum": [ + "RELAY_RESET_LIMIT_COUNTER_ZERO", + "RELAY_RESET_LIMIT_COUNTER_RELOAD_RATE", + "RELAY_RESET_LIMIT_COUNTER_MAX_VALUE", + "RELAY_RESET_LIMIT_COUNTER_NO_RESET" + ] + }, + "uplink_messages": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + } + } + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "uplink_forwarding_rules": { + "description": "Configured uplink forwarding rules.", + "type": "array", + "items": { + "type": "object", + "properties": { + "device_id": { + "description": "End device identifier of the served end device.", + "type": "string" + }, + "last_w_f_cnt": { + "description": "Last wake on radio frame counter used by the served end device.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "session_key_id": { + "description": "Session key ID of the session keys used to derive the root relay session key.", + "type": "string", + "format": "byte" + } + } + } + } + } + } + } + }, + "desired_rx1_data_rate_offset": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_OFFSET_0", + "enum": [ + "DATA_RATE_OFFSET_0", + "DATA_RATE_OFFSET_1", + "DATA_RATE_OFFSET_2", + "DATA_RATE_OFFSET_3", + "DATA_RATE_OFFSET_4", + "DATA_RATE_OFFSET_5", + "DATA_RATE_OFFSET_6", + "DATA_RATE_OFFSET_7" + ] + } + } + }, + "desired_rx1_delay": { + "type": "object", + "properties": { + "value": { + "description": " - RX_DELAY_0: 1 second.\n - RX_DELAY_1: 1 second.\n - RX_DELAY_2: 2 seconds.\n - RX_DELAY_3: 3 seconds.\n - RX_DELAY_4: 4 seconds.\n - RX_DELAY_5: 5 seconds.\n - RX_DELAY_6: 6 seconds.\n - RX_DELAY_7: 7 seconds.\n - RX_DELAY_8: 8 seconds.\n - RX_DELAY_9: 9 seconds.\n - RX_DELAY_10: 10 seconds.\n - RX_DELAY_11: 11 seconds.\n - RX_DELAY_12: 12 seconds.\n - RX_DELAY_13: 13 seconds.\n - RX_DELAY_14: 14 seconds.\n - RX_DELAY_15: 15 seconds.", + "type": "string", + "default": "RX_DELAY_0", + "enum": [ + "RX_DELAY_0", + "RX_DELAY_1", + "RX_DELAY_2", + "RX_DELAY_3", + "RX_DELAY_4", + "RX_DELAY_5", + "RX_DELAY_6", + "RX_DELAY_7", + "RX_DELAY_8", + "RX_DELAY_9", + "RX_DELAY_10", + "RX_DELAY_11", + "RX_DELAY_12", + "RX_DELAY_13", + "RX_DELAY_14", + "RX_DELAY_15" + ] + } + } + }, + "desired_rx2_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "desired_rx2_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "downlink_dwell_time": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "factory_preset_frequencies": { + "description": "List of factory-preset frequencies.\nIf unset, the default value from Network Server configuration or regional parameters specification will be used.", + "type": "array", + "items": { + "type": "string", + "format": "uint64" + } + }, + "max_duty_cycle": { + "type": "object", + "properties": { + "value": { + "description": " - DUTY_CYCLE_1: 100%.\n - DUTY_CYCLE_2: 50%.\n - DUTY_CYCLE_4: 25%.\n - DUTY_CYCLE_8: 12.5%.\n - DUTY_CYCLE_16: 6.25%.\n - DUTY_CYCLE_32: 3.125%.\n - DUTY_CYCLE_64: 1.5625%.\n - DUTY_CYCLE_128: Roughly 0.781%.\n - DUTY_CYCLE_256: Roughly 0.390%.\n - DUTY_CYCLE_512: Roughly 0.195%.\n - DUTY_CYCLE_1024: Roughly 0.098%.\n - DUTY_CYCLE_2048: Roughly 0.049%.\n - DUTY_CYCLE_4096: Roughly 0.024%.\n - DUTY_CYCLE_8192: Roughly 0.012%.\n - DUTY_CYCLE_16384: Roughly 0.006%.\n - DUTY_CYCLE_32768: Roughly 0.003%.", + "type": "string", + "default": "DUTY_CYCLE_1", + "enum": [ + "DUTY_CYCLE_1", + "DUTY_CYCLE_2", + "DUTY_CYCLE_4", + "DUTY_CYCLE_8", + "DUTY_CYCLE_16", + "DUTY_CYCLE_32", + "DUTY_CYCLE_64", + "DUTY_CYCLE_128", + "DUTY_CYCLE_256", + "DUTY_CYCLE_512", + "DUTY_CYCLE_1024", + "DUTY_CYCLE_2048", + "DUTY_CYCLE_4096", + "DUTY_CYCLE_8192", + "DUTY_CYCLE_16384", + "DUTY_CYCLE_32768" + ] + } + } + }, + "ping_slot_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "ping_slot_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "ping_slot_periodicity": { + "type": "object", + "properties": { + "value": { + "description": " - PING_EVERY_1S: Every second.\n - PING_EVERY_2S: Every 2 seconds.\n - PING_EVERY_4S: Every 4 seconds.\n - PING_EVERY_8S: Every 8 seconds.\n - PING_EVERY_16S: Every 16 seconds.\n - PING_EVERY_32S: Every 32 seconds.\n - PING_EVERY_64S: Every 64 seconds.\n - PING_EVERY_128S: Every 128 seconds.", + "type": "string", + "default": "PING_EVERY_1S", + "enum": [ + "PING_EVERY_1S", + "PING_EVERY_2S", + "PING_EVERY_4S", + "PING_EVERY_8S", + "PING_EVERY_16S", + "PING_EVERY_32S", + "PING_EVERY_64S", + "PING_EVERY_128S" + ] + } + } + }, + "relay": { + "description": "RelaySettings represent the settings of a relay.\nThis is used internally by the Network Server.", + "type": "object", + "properties": { + "served": { + "type": "object", + "properties": { + "always": { + "type": "object" + }, + "backoff": { + "description": "Number of wake on radio frames to be sent without an acknowledgement before sending the uplink message directly.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "dynamic": { + "type": "object", + "properties": { + "smart_enable_level": { + "type": "string", + "default": "RELAY_SMART_ENABLE_LEVEL_8", + "enum": [ + "RELAY_SMART_ENABLE_LEVEL_8", + "RELAY_SMART_ENABLE_LEVEL_16", + "RELAY_SMART_ENABLE_LEVEL_32", + "RELAY_SMART_ENABLE_LEVEL_64" + ] + } + } + }, + "end_device_controlled": { + "type": "object" + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "serving_device_id": { + "description": "End device identifier of the serving end device.", + "type": "string" + } + } + }, + "serving": { + "type": "object", + "properties": { + "cad_periodicity": { + "type": "string", + "title": "- RELAY_CAD_PERIODICITY_20_MILLISECONDS: sic", + "default": "RELAY_CAD_PERIODICITY_1_SECOND", + "enum": [ + "RELAY_CAD_PERIODICITY_1_SECOND", + "RELAY_CAD_PERIODICITY_500_MILLISECONDS", + "RELAY_CAD_PERIODICITY_250_MILLISECONDS", + "RELAY_CAD_PERIODICITY_100_MILLISECONDS", + "RELAY_CAD_PERIODICITY_50_MILLISECONDS", + "RELAY_CAD_PERIODICITY_20_MILLISECONDS" + ] + }, + "default_channel_index": { + "description": "Index of the default wake on radio channel.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "join_requests": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "notifications": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "overall": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "reset_behavior": { + "type": "string", + "default": "RELAY_RESET_LIMIT_COUNTER_ZERO", + "enum": [ + "RELAY_RESET_LIMIT_COUNTER_ZERO", + "RELAY_RESET_LIMIT_COUNTER_RELOAD_RATE", + "RELAY_RESET_LIMIT_COUNTER_MAX_VALUE", + "RELAY_RESET_LIMIT_COUNTER_NO_RESET" + ] + }, + "uplink_messages": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + } + } + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "uplink_forwarding_rules": { + "description": "Configured uplink forwarding rules.", + "type": "array", + "items": { + "type": "object", + "properties": { + "device_id": { + "description": "End device identifier of the served end device.", + "type": "string" + }, + "last_w_f_cnt": { + "description": "Last wake on radio frame counter used by the served end device.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "session_key_id": { + "description": "Session key ID of the session keys used to derive the root relay session key.", + "type": "string", + "format": "byte" + } + } + } + } + } + } + } + }, + "resets_f_cnt": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "rx1_data_rate_offset": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_OFFSET_0", + "enum": [ + "DATA_RATE_OFFSET_0", + "DATA_RATE_OFFSET_1", + "DATA_RATE_OFFSET_2", + "DATA_RATE_OFFSET_3", + "DATA_RATE_OFFSET_4", + "DATA_RATE_OFFSET_5", + "DATA_RATE_OFFSET_6", + "DATA_RATE_OFFSET_7" + ] + } + } + }, + "rx1_delay": { + "type": "object", + "properties": { + "value": { + "description": " - RX_DELAY_0: 1 second.\n - RX_DELAY_1: 1 second.\n - RX_DELAY_2: 2 seconds.\n - RX_DELAY_3: 3 seconds.\n - RX_DELAY_4: 4 seconds.\n - RX_DELAY_5: 5 seconds.\n - RX_DELAY_6: 6 seconds.\n - RX_DELAY_7: 7 seconds.\n - RX_DELAY_8: 8 seconds.\n - RX_DELAY_9: 9 seconds.\n - RX_DELAY_10: 10 seconds.\n - RX_DELAY_11: 11 seconds.\n - RX_DELAY_12: 12 seconds.\n - RX_DELAY_13: 13 seconds.\n - RX_DELAY_14: 14 seconds.\n - RX_DELAY_15: 15 seconds.", + "type": "string", + "default": "RX_DELAY_0", + "enum": [ + "RX_DELAY_0", + "RX_DELAY_1", + "RX_DELAY_2", + "RX_DELAY_3", + "RX_DELAY_4", + "RX_DELAY_5", + "RX_DELAY_6", + "RX_DELAY_7", + "RX_DELAY_8", + "RX_DELAY_9", + "RX_DELAY_10", + "RX_DELAY_11", + "RX_DELAY_12", + "RX_DELAY_13", + "RX_DELAY_14", + "RX_DELAY_15" + ] + } + } + }, + "rx2_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "rx2_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "schedule_downlinks": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "status_count_periodicity": { + "description": "Number of uplink messages after which a DevStatusReq MACCommand shall be sent.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "status_time_periodicity": { + "description": "The interval after which a DevStatusReq MACCommand shall be sent.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "supports_32_bit_f_cnt": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "uplink_dwell_time": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "use_adr": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + } + } + } + } + } + } + }, "v3GetNetIDResponse": { "type": "object", "properties": { @@ -633210,6 +650117,1541 @@ } } }, + "v3ListMACSettingsProfilesResponse": { + "type": "object", + "properties": { + "mac_settings_profiles": { + "description": "The MAC settings profiles.", + "type": "array", + "items": { + "type": "object", + "properties": { + "ids": { + "type": "object", + "properties": { + "application_ids": { + "type": "object", + "properties": { + "application_id": { + "type": "string" + } + } + }, + "profile_id": { + "description": "Profile ID.", + "type": "string" + } + } + }, + "mac_settings": { + "type": "object", + "properties": { + "adr": { + "description": "Adaptive Data Rate settings.", + "type": "object", + "properties": { + "disabled": { + "description": "Configuration options for cases in which ADR is to be disabled\ncompletely.", + "type": "object" + }, + "dynamic": { + "description": "Configuration options for dynamic ADR.", + "type": "object", + "properties": { + "channel_steering": { + "description": "EXPERIMENTAL: Channel steering settings.", + "type": "object", + "properties": { + "disabled": { + "description": "Configuration options for cases in which ADR is not supposed to steer the end device\nto another set of channels.", + "type": "object" + }, + "lora_narrow": { + "description": "Configuration options for LoRa narrow channels steering.\nThe narrow mode attempts to steer the end device towards\nusing the LoRa modulated, 125kHz bandwidth channels.", + "type": "object" + } + } + }, + "margin": { + "description": "The ADR margin (dB) tells the network server how much margin it should add in ADR requests.\nA bigger margin is less efficient, but gives a better chance of successful reception.\nIf unset, the default value from Network Server configuration will be used.", + "type": "number", + "format": "float" + }, + "max_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "max_tx_power_index": { + "description": "Maximum transmission power index.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_tx_power_index": { + "description": "Minimum transmission power index.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "overrides": { + "description": "EXPERIMENTAL: Configuration overrides.", + "type": "object", + "properties": { + "data_rate_0": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_1": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_10": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_11": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_12": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_13": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_14": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_15": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_2": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_3": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_4": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_5": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_6": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_7": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_8": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_9": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + } + } + } + } + }, + "static": { + "description": "Configuration options for static ADR.", + "type": "object", + "properties": { + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "nb_trans": { + "description": "Number of retransmissions.", + "type": "integer", + "format": "int64" + }, + "tx_power_index": { + "description": "Transmission power index to use.", + "type": "integer", + "format": "int64" + } + } + } + } + }, + "adr_margin": { + "description": "The ADR margin (dB) tells the network server how much margin it should add in ADR requests.\nA bigger margin is less efficient, but gives a better chance of successful reception.\nThis field is deprecated, use adr_settings.dynamic.margin instead.", + "type": "number", + "format": "float" + }, + "beacon_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "class_b_c_downlink_interval": { + "description": "The minimum duration passed before a network-initiated(e.g. Class B or C) downlink following an arbitrary downlink.", + "type": "string" + }, + "class_b_timeout": { + "description": "Maximum delay for the device to answer a MAC request or a confirmed downlink frame.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "class_c_timeout": { + "description": "Maximum delay for the device to answer a MAC request or a confirmed downlink frame.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "desired_adr_ack_delay_exponent": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "ADR_ACK_DELAY_1", + "enum": [ + "ADR_ACK_DELAY_1", + "ADR_ACK_DELAY_2", + "ADR_ACK_DELAY_4", + "ADR_ACK_DELAY_8", + "ADR_ACK_DELAY_16", + "ADR_ACK_DELAY_32", + "ADR_ACK_DELAY_64", + "ADR_ACK_DELAY_128", + "ADR_ACK_DELAY_256", + "ADR_ACK_DELAY_512", + "ADR_ACK_DELAY_1024", + "ADR_ACK_DELAY_2048", + "ADR_ACK_DELAY_4096", + "ADR_ACK_DELAY_8192", + "ADR_ACK_DELAY_16384", + "ADR_ACK_DELAY_32768" + ] + } + } + }, + "desired_adr_ack_limit_exponent": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "ADR_ACK_LIMIT_1", + "enum": [ + "ADR_ACK_LIMIT_1", + "ADR_ACK_LIMIT_2", + "ADR_ACK_LIMIT_4", + "ADR_ACK_LIMIT_8", + "ADR_ACK_LIMIT_16", + "ADR_ACK_LIMIT_32", + "ADR_ACK_LIMIT_64", + "ADR_ACK_LIMIT_128", + "ADR_ACK_LIMIT_256", + "ADR_ACK_LIMIT_512", + "ADR_ACK_LIMIT_1024", + "ADR_ACK_LIMIT_2048", + "ADR_ACK_LIMIT_4096", + "ADR_ACK_LIMIT_8192", + "ADR_ACK_LIMIT_16384", + "ADR_ACK_LIMIT_32768" + ] + } + } + }, + "desired_beacon_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "desired_max_duty_cycle": { + "type": "object", + "properties": { + "value": { + "description": " - DUTY_CYCLE_1: 100%.\n - DUTY_CYCLE_2: 50%.\n - DUTY_CYCLE_4: 25%.\n - DUTY_CYCLE_8: 12.5%.\n - DUTY_CYCLE_16: 6.25%.\n - DUTY_CYCLE_32: 3.125%.\n - DUTY_CYCLE_64: 1.5625%.\n - DUTY_CYCLE_128: Roughly 0.781%.\n - DUTY_CYCLE_256: Roughly 0.390%.\n - DUTY_CYCLE_512: Roughly 0.195%.\n - DUTY_CYCLE_1024: Roughly 0.098%.\n - DUTY_CYCLE_2048: Roughly 0.049%.\n - DUTY_CYCLE_4096: Roughly 0.024%.\n - DUTY_CYCLE_8192: Roughly 0.012%.\n - DUTY_CYCLE_16384: Roughly 0.006%.\n - DUTY_CYCLE_32768: Roughly 0.003%.", + "type": "string", + "default": "DUTY_CYCLE_1", + "enum": [ + "DUTY_CYCLE_1", + "DUTY_CYCLE_2", + "DUTY_CYCLE_4", + "DUTY_CYCLE_8", + "DUTY_CYCLE_16", + "DUTY_CYCLE_32", + "DUTY_CYCLE_64", + "DUTY_CYCLE_128", + "DUTY_CYCLE_256", + "DUTY_CYCLE_512", + "DUTY_CYCLE_1024", + "DUTY_CYCLE_2048", + "DUTY_CYCLE_4096", + "DUTY_CYCLE_8192", + "DUTY_CYCLE_16384", + "DUTY_CYCLE_32768" + ] + } + } + }, + "desired_max_eirp": { + "type": "object", + "properties": { + "value": { + "description": " - DEVICE_EIRP_8: 8 dBm.\n - DEVICE_EIRP_10: 10 dBm.\n - DEVICE_EIRP_12: 12 dBm.\n - DEVICE_EIRP_13: 13 dBm.\n - DEVICE_EIRP_14: 14 dBm.\n - DEVICE_EIRP_16: 16 dBm.\n - DEVICE_EIRP_18: 18 dBm.\n - DEVICE_EIRP_20: 20 dBm.\n - DEVICE_EIRP_21: 21 dBm.\n - DEVICE_EIRP_24: 24 dBm.\n - DEVICE_EIRP_26: 26 dBm.\n - DEVICE_EIRP_27: 27 dBm.\n - DEVICE_EIRP_29: 29 dBm.\n - DEVICE_EIRP_30: 30 dBm.\n - DEVICE_EIRP_33: 33 dBm.\n - DEVICE_EIRP_36: 36 dBm.", + "type": "string", + "default": "DEVICE_EIRP_8", + "enum": [ + "DEVICE_EIRP_8", + "DEVICE_EIRP_10", + "DEVICE_EIRP_12", + "DEVICE_EIRP_13", + "DEVICE_EIRP_14", + "DEVICE_EIRP_16", + "DEVICE_EIRP_18", + "DEVICE_EIRP_20", + "DEVICE_EIRP_21", + "DEVICE_EIRP_24", + "DEVICE_EIRP_26", + "DEVICE_EIRP_27", + "DEVICE_EIRP_29", + "DEVICE_EIRP_30", + "DEVICE_EIRP_33", + "DEVICE_EIRP_36" + ] + } + } + }, + "desired_ping_slot_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "desired_ping_slot_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "desired_relay": { + "description": "RelaySettings represent the settings of a relay.\nThis is used internally by the Network Server.", + "type": "object", + "properties": { + "served": { + "type": "object", + "properties": { + "always": { + "type": "object" + }, + "backoff": { + "description": "Number of wake on radio frames to be sent without an acknowledgement before sending the uplink message directly.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "dynamic": { + "type": "object", + "properties": { + "smart_enable_level": { + "type": "string", + "default": "RELAY_SMART_ENABLE_LEVEL_8", + "enum": [ + "RELAY_SMART_ENABLE_LEVEL_8", + "RELAY_SMART_ENABLE_LEVEL_16", + "RELAY_SMART_ENABLE_LEVEL_32", + "RELAY_SMART_ENABLE_LEVEL_64" + ] + } + } + }, + "end_device_controlled": { + "type": "object" + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "serving_device_id": { + "description": "End device identifier of the serving end device.", + "type": "string" + } + } + }, + "serving": { + "type": "object", + "properties": { + "cad_periodicity": { + "type": "string", + "title": "- RELAY_CAD_PERIODICITY_20_MILLISECONDS: sic", + "default": "RELAY_CAD_PERIODICITY_1_SECOND", + "enum": [ + "RELAY_CAD_PERIODICITY_1_SECOND", + "RELAY_CAD_PERIODICITY_500_MILLISECONDS", + "RELAY_CAD_PERIODICITY_250_MILLISECONDS", + "RELAY_CAD_PERIODICITY_100_MILLISECONDS", + "RELAY_CAD_PERIODICITY_50_MILLISECONDS", + "RELAY_CAD_PERIODICITY_20_MILLISECONDS" + ] + }, + "default_channel_index": { + "description": "Index of the default wake on radio channel.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "join_requests": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "notifications": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "overall": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "reset_behavior": { + "type": "string", + "default": "RELAY_RESET_LIMIT_COUNTER_ZERO", + "enum": [ + "RELAY_RESET_LIMIT_COUNTER_ZERO", + "RELAY_RESET_LIMIT_COUNTER_RELOAD_RATE", + "RELAY_RESET_LIMIT_COUNTER_MAX_VALUE", + "RELAY_RESET_LIMIT_COUNTER_NO_RESET" + ] + }, + "uplink_messages": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + } + } + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "uplink_forwarding_rules": { + "description": "Configured uplink forwarding rules.", + "type": "array", + "items": { + "type": "object", + "properties": { + "device_id": { + "description": "End device identifier of the served end device.", + "type": "string" + }, + "last_w_f_cnt": { + "description": "Last wake on radio frame counter used by the served end device.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "session_key_id": { + "description": "Session key ID of the session keys used to derive the root relay session key.", + "type": "string", + "format": "byte" + } + } + } + } + } + } + } + }, + "desired_rx1_data_rate_offset": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_OFFSET_0", + "enum": [ + "DATA_RATE_OFFSET_0", + "DATA_RATE_OFFSET_1", + "DATA_RATE_OFFSET_2", + "DATA_RATE_OFFSET_3", + "DATA_RATE_OFFSET_4", + "DATA_RATE_OFFSET_5", + "DATA_RATE_OFFSET_6", + "DATA_RATE_OFFSET_7" + ] + } + } + }, + "desired_rx1_delay": { + "type": "object", + "properties": { + "value": { + "description": " - RX_DELAY_0: 1 second.\n - RX_DELAY_1: 1 second.\n - RX_DELAY_2: 2 seconds.\n - RX_DELAY_3: 3 seconds.\n - RX_DELAY_4: 4 seconds.\n - RX_DELAY_5: 5 seconds.\n - RX_DELAY_6: 6 seconds.\n - RX_DELAY_7: 7 seconds.\n - RX_DELAY_8: 8 seconds.\n - RX_DELAY_9: 9 seconds.\n - RX_DELAY_10: 10 seconds.\n - RX_DELAY_11: 11 seconds.\n - RX_DELAY_12: 12 seconds.\n - RX_DELAY_13: 13 seconds.\n - RX_DELAY_14: 14 seconds.\n - RX_DELAY_15: 15 seconds.", + "type": "string", + "default": "RX_DELAY_0", + "enum": [ + "RX_DELAY_0", + "RX_DELAY_1", + "RX_DELAY_2", + "RX_DELAY_3", + "RX_DELAY_4", + "RX_DELAY_5", + "RX_DELAY_6", + "RX_DELAY_7", + "RX_DELAY_8", + "RX_DELAY_9", + "RX_DELAY_10", + "RX_DELAY_11", + "RX_DELAY_12", + "RX_DELAY_13", + "RX_DELAY_14", + "RX_DELAY_15" + ] + } + } + }, + "desired_rx2_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "desired_rx2_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "downlink_dwell_time": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "factory_preset_frequencies": { + "description": "List of factory-preset frequencies.\nIf unset, the default value from Network Server configuration or regional parameters specification will be used.", + "type": "array", + "items": { + "type": "string", + "format": "uint64" + } + }, + "max_duty_cycle": { + "type": "object", + "properties": { + "value": { + "description": " - DUTY_CYCLE_1: 100%.\n - DUTY_CYCLE_2: 50%.\n - DUTY_CYCLE_4: 25%.\n - DUTY_CYCLE_8: 12.5%.\n - DUTY_CYCLE_16: 6.25%.\n - DUTY_CYCLE_32: 3.125%.\n - DUTY_CYCLE_64: 1.5625%.\n - DUTY_CYCLE_128: Roughly 0.781%.\n - DUTY_CYCLE_256: Roughly 0.390%.\n - DUTY_CYCLE_512: Roughly 0.195%.\n - DUTY_CYCLE_1024: Roughly 0.098%.\n - DUTY_CYCLE_2048: Roughly 0.049%.\n - DUTY_CYCLE_4096: Roughly 0.024%.\n - DUTY_CYCLE_8192: Roughly 0.012%.\n - DUTY_CYCLE_16384: Roughly 0.006%.\n - DUTY_CYCLE_32768: Roughly 0.003%.", + "type": "string", + "default": "DUTY_CYCLE_1", + "enum": [ + "DUTY_CYCLE_1", + "DUTY_CYCLE_2", + "DUTY_CYCLE_4", + "DUTY_CYCLE_8", + "DUTY_CYCLE_16", + "DUTY_CYCLE_32", + "DUTY_CYCLE_64", + "DUTY_CYCLE_128", + "DUTY_CYCLE_256", + "DUTY_CYCLE_512", + "DUTY_CYCLE_1024", + "DUTY_CYCLE_2048", + "DUTY_CYCLE_4096", + "DUTY_CYCLE_8192", + "DUTY_CYCLE_16384", + "DUTY_CYCLE_32768" + ] + } + } + }, + "ping_slot_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "ping_slot_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "ping_slot_periodicity": { + "type": "object", + "properties": { + "value": { + "description": " - PING_EVERY_1S: Every second.\n - PING_EVERY_2S: Every 2 seconds.\n - PING_EVERY_4S: Every 4 seconds.\n - PING_EVERY_8S: Every 8 seconds.\n - PING_EVERY_16S: Every 16 seconds.\n - PING_EVERY_32S: Every 32 seconds.\n - PING_EVERY_64S: Every 64 seconds.\n - PING_EVERY_128S: Every 128 seconds.", + "type": "string", + "default": "PING_EVERY_1S", + "enum": [ + "PING_EVERY_1S", + "PING_EVERY_2S", + "PING_EVERY_4S", + "PING_EVERY_8S", + "PING_EVERY_16S", + "PING_EVERY_32S", + "PING_EVERY_64S", + "PING_EVERY_128S" + ] + } + } + }, + "relay": { + "description": "RelaySettings represent the settings of a relay.\nThis is used internally by the Network Server.", + "type": "object", + "properties": { + "served": { + "type": "object", + "properties": { + "always": { + "type": "object" + }, + "backoff": { + "description": "Number of wake on radio frames to be sent without an acknowledgement before sending the uplink message directly.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "dynamic": { + "type": "object", + "properties": { + "smart_enable_level": { + "type": "string", + "default": "RELAY_SMART_ENABLE_LEVEL_8", + "enum": [ + "RELAY_SMART_ENABLE_LEVEL_8", + "RELAY_SMART_ENABLE_LEVEL_16", + "RELAY_SMART_ENABLE_LEVEL_32", + "RELAY_SMART_ENABLE_LEVEL_64" + ] + } + } + }, + "end_device_controlled": { + "type": "object" + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "serving_device_id": { + "description": "End device identifier of the serving end device.", + "type": "string" + } + } + }, + "serving": { + "type": "object", + "properties": { + "cad_periodicity": { + "type": "string", + "title": "- RELAY_CAD_PERIODICITY_20_MILLISECONDS: sic", + "default": "RELAY_CAD_PERIODICITY_1_SECOND", + "enum": [ + "RELAY_CAD_PERIODICITY_1_SECOND", + "RELAY_CAD_PERIODICITY_500_MILLISECONDS", + "RELAY_CAD_PERIODICITY_250_MILLISECONDS", + "RELAY_CAD_PERIODICITY_100_MILLISECONDS", + "RELAY_CAD_PERIODICITY_50_MILLISECONDS", + "RELAY_CAD_PERIODICITY_20_MILLISECONDS" + ] + }, + "default_channel_index": { + "description": "Index of the default wake on radio channel.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "join_requests": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "notifications": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "overall": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "reset_behavior": { + "type": "string", + "default": "RELAY_RESET_LIMIT_COUNTER_ZERO", + "enum": [ + "RELAY_RESET_LIMIT_COUNTER_ZERO", + "RELAY_RESET_LIMIT_COUNTER_RELOAD_RATE", + "RELAY_RESET_LIMIT_COUNTER_MAX_VALUE", + "RELAY_RESET_LIMIT_COUNTER_NO_RESET" + ] + }, + "uplink_messages": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + } + } + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "uplink_forwarding_rules": { + "description": "Configured uplink forwarding rules.", + "type": "array", + "items": { + "type": "object", + "properties": { + "device_id": { + "description": "End device identifier of the served end device.", + "type": "string" + }, + "last_w_f_cnt": { + "description": "Last wake on radio frame counter used by the served end device.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "session_key_id": { + "description": "Session key ID of the session keys used to derive the root relay session key.", + "type": "string", + "format": "byte" + } + } + } + } + } + } + } + }, + "resets_f_cnt": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "rx1_data_rate_offset": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_OFFSET_0", + "enum": [ + "DATA_RATE_OFFSET_0", + "DATA_RATE_OFFSET_1", + "DATA_RATE_OFFSET_2", + "DATA_RATE_OFFSET_3", + "DATA_RATE_OFFSET_4", + "DATA_RATE_OFFSET_5", + "DATA_RATE_OFFSET_6", + "DATA_RATE_OFFSET_7" + ] + } + } + }, + "rx1_delay": { + "type": "object", + "properties": { + "value": { + "description": " - RX_DELAY_0: 1 second.\n - RX_DELAY_1: 1 second.\n - RX_DELAY_2: 2 seconds.\n - RX_DELAY_3: 3 seconds.\n - RX_DELAY_4: 4 seconds.\n - RX_DELAY_5: 5 seconds.\n - RX_DELAY_6: 6 seconds.\n - RX_DELAY_7: 7 seconds.\n - RX_DELAY_8: 8 seconds.\n - RX_DELAY_9: 9 seconds.\n - RX_DELAY_10: 10 seconds.\n - RX_DELAY_11: 11 seconds.\n - RX_DELAY_12: 12 seconds.\n - RX_DELAY_13: 13 seconds.\n - RX_DELAY_14: 14 seconds.\n - RX_DELAY_15: 15 seconds.", + "type": "string", + "default": "RX_DELAY_0", + "enum": [ + "RX_DELAY_0", + "RX_DELAY_1", + "RX_DELAY_2", + "RX_DELAY_3", + "RX_DELAY_4", + "RX_DELAY_5", + "RX_DELAY_6", + "RX_DELAY_7", + "RX_DELAY_8", + "RX_DELAY_9", + "RX_DELAY_10", + "RX_DELAY_11", + "RX_DELAY_12", + "RX_DELAY_13", + "RX_DELAY_14", + "RX_DELAY_15" + ] + } + } + }, + "rx2_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "rx2_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "schedule_downlinks": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "status_count_periodicity": { + "description": "Number of uplink messages after which a DevStatusReq MACCommand shall be sent.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "status_time_periodicity": { + "description": "The interval after which a DevStatusReq MACCommand shall be sent.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "supports_32_bit_f_cnt": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "uplink_dwell_time": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "use_adr": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + } + } + } + } + } + } + } + }, "v3ListNotificationsResponse": { "type": "object", "properties": { @@ -633335,7 +651777,7 @@ "type": "string" }, "notification_type": { - "description": "The type of this notification.", + "description": "The type of this notification.\nTODO: Replace with type NotificationType in v4 https://github.com/TheThingsNetwork/lorawan-stack/issues/7384.", "type": "string" }, "receivers": { @@ -636750,192 +655192,1735 @@ "DATA_RATE_15" ] }, - "frequency": { - "description": "The frequency (Hz) used by the wake on radio message.", - "type": "string", - "format": "uint64" + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "uplink_forwarding_rules": { + "description": "Configured uplink forwarding rules.", + "type": "array", + "items": { + "type": "object", + "properties": { + "device_id": { + "description": "End device identifier of the served end device.", + "type": "string" + }, + "last_w_f_cnt": { + "description": "Last wake on radio frame counter used by the served end device.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "session_key_id": { + "description": "Session key ID of the session keys used to derive the root relay session key.", + "type": "string", + "format": "byte" + } + } + } + } + } + } + } + }, + "resets_f_cnt": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "rx1_data_rate_offset": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_OFFSET_0", + "enum": [ + "DATA_RATE_OFFSET_0", + "DATA_RATE_OFFSET_1", + "DATA_RATE_OFFSET_2", + "DATA_RATE_OFFSET_3", + "DATA_RATE_OFFSET_4", + "DATA_RATE_OFFSET_5", + "DATA_RATE_OFFSET_6", + "DATA_RATE_OFFSET_7" + ] + } + } + }, + "rx1_delay": { + "type": "object", + "properties": { + "value": { + "description": " - RX_DELAY_0: 1 second.\n - RX_DELAY_1: 1 second.\n - RX_DELAY_2: 2 seconds.\n - RX_DELAY_3: 3 seconds.\n - RX_DELAY_4: 4 seconds.\n - RX_DELAY_5: 5 seconds.\n - RX_DELAY_6: 6 seconds.\n - RX_DELAY_7: 7 seconds.\n - RX_DELAY_8: 8 seconds.\n - RX_DELAY_9: 9 seconds.\n - RX_DELAY_10: 10 seconds.\n - RX_DELAY_11: 11 seconds.\n - RX_DELAY_12: 12 seconds.\n - RX_DELAY_13: 13 seconds.\n - RX_DELAY_14: 14 seconds.\n - RX_DELAY_15: 15 seconds.", + "type": "string", + "default": "RX_DELAY_0", + "enum": [ + "RX_DELAY_0", + "RX_DELAY_1", + "RX_DELAY_2", + "RX_DELAY_3", + "RX_DELAY_4", + "RX_DELAY_5", + "RX_DELAY_6", + "RX_DELAY_7", + "RX_DELAY_8", + "RX_DELAY_9", + "RX_DELAY_10", + "RX_DELAY_11", + "RX_DELAY_12", + "RX_DELAY_13", + "RX_DELAY_14", + "RX_DELAY_15" + ] + } + } + }, + "rx2_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "rx2_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "schedule_downlinks": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "status_count_periodicity": { + "description": "Number of uplink messages after which a DevStatusReq MACCommand shall be sent.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "status_time_periodicity": { + "description": "The interval after which a DevStatusReq MACCommand shall be sent.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "supports_32_bit_f_cnt": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "uplink_dwell_time": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "use_adr": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + } + } + }, + "v3MACSettingsProfile": { + "type": "object", + "properties": { + "ids": { + "type": "object", + "properties": { + "application_ids": { + "type": "object", + "properties": { + "application_id": { + "type": "string" + } + } + }, + "profile_id": { + "description": "Profile ID.", + "type": "string" + } + } + }, + "mac_settings": { + "type": "object", + "properties": { + "adr": { + "description": "Adaptive Data Rate settings.", + "type": "object", + "properties": { + "disabled": { + "description": "Configuration options for cases in which ADR is to be disabled\ncompletely.", + "type": "object" + }, + "dynamic": { + "description": "Configuration options for dynamic ADR.", + "type": "object", + "properties": { + "channel_steering": { + "description": "EXPERIMENTAL: Channel steering settings.", + "type": "object", + "properties": { + "disabled": { + "description": "Configuration options for cases in which ADR is not supposed to steer the end device\nto another set of channels.", + "type": "object" + }, + "lora_narrow": { + "description": "Configuration options for LoRa narrow channels steering.\nThe narrow mode attempts to steer the end device towards\nusing the LoRa modulated, 125kHz bandwidth channels.", + "type": "object" + } + } + }, + "margin": { + "description": "The ADR margin (dB) tells the network server how much margin it should add in ADR requests.\nA bigger margin is less efficient, but gives a better chance of successful reception.\nIf unset, the default value from Network Server configuration will be used.", + "type": "number", + "format": "float" + }, + "max_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "max_tx_power_index": { + "description": "Maximum transmission power index.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_tx_power_index": { + "description": "Minimum transmission power index.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "overrides": { + "description": "EXPERIMENTAL: Configuration overrides.", + "type": "object", + "properties": { + "data_rate_0": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_1": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_10": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_11": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_12": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_13": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_14": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_15": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_2": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_3": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_4": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_5": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_6": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_7": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_8": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_9": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + } + } + } + } + }, + "static": { + "description": "Configuration options for static ADR.", + "type": "object", + "properties": { + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "nb_trans": { + "description": "Number of retransmissions.", + "type": "integer", + "format": "int64" + }, + "tx_power_index": { + "description": "Transmission power index to use.", + "type": "integer", + "format": "int64" + } + } + } + } + }, + "adr_margin": { + "description": "The ADR margin (dB) tells the network server how much margin it should add in ADR requests.\nA bigger margin is less efficient, but gives a better chance of successful reception.\nThis field is deprecated, use adr_settings.dynamic.margin instead.", + "type": "number", + "format": "float" + }, + "beacon_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "class_b_c_downlink_interval": { + "description": "The minimum duration passed before a network-initiated(e.g. Class B or C) downlink following an arbitrary downlink.", + "type": "string" + }, + "class_b_timeout": { + "description": "Maximum delay for the device to answer a MAC request or a confirmed downlink frame.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "class_c_timeout": { + "description": "Maximum delay for the device to answer a MAC request or a confirmed downlink frame.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "desired_adr_ack_delay_exponent": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "ADR_ACK_DELAY_1", + "enum": [ + "ADR_ACK_DELAY_1", + "ADR_ACK_DELAY_2", + "ADR_ACK_DELAY_4", + "ADR_ACK_DELAY_8", + "ADR_ACK_DELAY_16", + "ADR_ACK_DELAY_32", + "ADR_ACK_DELAY_64", + "ADR_ACK_DELAY_128", + "ADR_ACK_DELAY_256", + "ADR_ACK_DELAY_512", + "ADR_ACK_DELAY_1024", + "ADR_ACK_DELAY_2048", + "ADR_ACK_DELAY_4096", + "ADR_ACK_DELAY_8192", + "ADR_ACK_DELAY_16384", + "ADR_ACK_DELAY_32768" + ] + } + } + }, + "desired_adr_ack_limit_exponent": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "ADR_ACK_LIMIT_1", + "enum": [ + "ADR_ACK_LIMIT_1", + "ADR_ACK_LIMIT_2", + "ADR_ACK_LIMIT_4", + "ADR_ACK_LIMIT_8", + "ADR_ACK_LIMIT_16", + "ADR_ACK_LIMIT_32", + "ADR_ACK_LIMIT_64", + "ADR_ACK_LIMIT_128", + "ADR_ACK_LIMIT_256", + "ADR_ACK_LIMIT_512", + "ADR_ACK_LIMIT_1024", + "ADR_ACK_LIMIT_2048", + "ADR_ACK_LIMIT_4096", + "ADR_ACK_LIMIT_8192", + "ADR_ACK_LIMIT_16384", + "ADR_ACK_LIMIT_32768" + ] + } + } + }, + "desired_beacon_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "desired_max_duty_cycle": { + "type": "object", + "properties": { + "value": { + "description": " - DUTY_CYCLE_1: 100%.\n - DUTY_CYCLE_2: 50%.\n - DUTY_CYCLE_4: 25%.\n - DUTY_CYCLE_8: 12.5%.\n - DUTY_CYCLE_16: 6.25%.\n - DUTY_CYCLE_32: 3.125%.\n - DUTY_CYCLE_64: 1.5625%.\n - DUTY_CYCLE_128: Roughly 0.781%.\n - DUTY_CYCLE_256: Roughly 0.390%.\n - DUTY_CYCLE_512: Roughly 0.195%.\n - DUTY_CYCLE_1024: Roughly 0.098%.\n - DUTY_CYCLE_2048: Roughly 0.049%.\n - DUTY_CYCLE_4096: Roughly 0.024%.\n - DUTY_CYCLE_8192: Roughly 0.012%.\n - DUTY_CYCLE_16384: Roughly 0.006%.\n - DUTY_CYCLE_32768: Roughly 0.003%.", + "type": "string", + "default": "DUTY_CYCLE_1", + "enum": [ + "DUTY_CYCLE_1", + "DUTY_CYCLE_2", + "DUTY_CYCLE_4", + "DUTY_CYCLE_8", + "DUTY_CYCLE_16", + "DUTY_CYCLE_32", + "DUTY_CYCLE_64", + "DUTY_CYCLE_128", + "DUTY_CYCLE_256", + "DUTY_CYCLE_512", + "DUTY_CYCLE_1024", + "DUTY_CYCLE_2048", + "DUTY_CYCLE_4096", + "DUTY_CYCLE_8192", + "DUTY_CYCLE_16384", + "DUTY_CYCLE_32768" + ] + } + } + }, + "desired_max_eirp": { + "type": "object", + "properties": { + "value": { + "description": " - DEVICE_EIRP_8: 8 dBm.\n - DEVICE_EIRP_10: 10 dBm.\n - DEVICE_EIRP_12: 12 dBm.\n - DEVICE_EIRP_13: 13 dBm.\n - DEVICE_EIRP_14: 14 dBm.\n - DEVICE_EIRP_16: 16 dBm.\n - DEVICE_EIRP_18: 18 dBm.\n - DEVICE_EIRP_20: 20 dBm.\n - DEVICE_EIRP_21: 21 dBm.\n - DEVICE_EIRP_24: 24 dBm.\n - DEVICE_EIRP_26: 26 dBm.\n - DEVICE_EIRP_27: 27 dBm.\n - DEVICE_EIRP_29: 29 dBm.\n - DEVICE_EIRP_30: 30 dBm.\n - DEVICE_EIRP_33: 33 dBm.\n - DEVICE_EIRP_36: 36 dBm.", + "type": "string", + "default": "DEVICE_EIRP_8", + "enum": [ + "DEVICE_EIRP_8", + "DEVICE_EIRP_10", + "DEVICE_EIRP_12", + "DEVICE_EIRP_13", + "DEVICE_EIRP_14", + "DEVICE_EIRP_16", + "DEVICE_EIRP_18", + "DEVICE_EIRP_20", + "DEVICE_EIRP_21", + "DEVICE_EIRP_24", + "DEVICE_EIRP_26", + "DEVICE_EIRP_27", + "DEVICE_EIRP_29", + "DEVICE_EIRP_30", + "DEVICE_EIRP_33", + "DEVICE_EIRP_36" + ] + } + } + }, + "desired_ping_slot_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "desired_ping_slot_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "desired_relay": { + "description": "RelaySettings represent the settings of a relay.\nThis is used internally by the Network Server.", + "type": "object", + "properties": { + "served": { + "type": "object", + "properties": { + "always": { + "type": "object" + }, + "backoff": { + "description": "Number of wake on radio frames to be sent without an acknowledgement before sending the uplink message directly.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "dynamic": { + "type": "object", + "properties": { + "smart_enable_level": { + "type": "string", + "default": "RELAY_SMART_ENABLE_LEVEL_8", + "enum": [ + "RELAY_SMART_ENABLE_LEVEL_8", + "RELAY_SMART_ENABLE_LEVEL_16", + "RELAY_SMART_ENABLE_LEVEL_32", + "RELAY_SMART_ENABLE_LEVEL_64" + ] + } + } + }, + "end_device_controlled": { + "type": "object" + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "serving_device_id": { + "description": "End device identifier of the serving end device.", + "type": "string" } } }, - "uplink_forwarding_rules": { - "description": "Configured uplink forwarding rules.", - "type": "array", - "items": { - "type": "object", - "properties": { - "device_id": { - "description": "End device identifier of the served end device.", - "type": "string" - }, - "last_w_f_cnt": { - "description": "Last wake on radio frame counter used by the served end device.", - "type": "integer", - "format": "int64" - }, - "limits": { + "serving": { + "type": "object", + "properties": { + "cad_periodicity": { + "type": "string", + "title": "- RELAY_CAD_PERIODICITY_20_MILLISECONDS: sic", + "default": "RELAY_CAD_PERIODICITY_1_SECOND", + "enum": [ + "RELAY_CAD_PERIODICITY_1_SECOND", + "RELAY_CAD_PERIODICITY_500_MILLISECONDS", + "RELAY_CAD_PERIODICITY_250_MILLISECONDS", + "RELAY_CAD_PERIODICITY_100_MILLISECONDS", + "RELAY_CAD_PERIODICITY_50_MILLISECONDS", + "RELAY_CAD_PERIODICITY_20_MILLISECONDS" + ] + }, + "default_channel_index": { + "description": "Index of the default wake on radio channel.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "join_requests": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "notifications": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "overall": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "reset_behavior": { + "type": "string", + "default": "RELAY_RESET_LIMIT_COUNTER_ZERO", + "enum": [ + "RELAY_RESET_LIMIT_COUNTER_ZERO", + "RELAY_RESET_LIMIT_COUNTER_RELOAD_RATE", + "RELAY_RESET_LIMIT_COUNTER_MAX_VALUE", + "RELAY_RESET_LIMIT_COUNTER_NO_RESET" + ] + }, + "uplink_messages": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + } + } + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "uplink_forwarding_rules": { + "description": "Configured uplink forwarding rules.", + "type": "array", + "items": { "type": "object", "properties": { - "bucket_size": { + "device_id": { + "description": "End device identifier of the served end device.", + "type": "string" + }, + "last_w_f_cnt": { + "description": "Last wake on radio frame counter used by the served end device.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "session_key_id": { + "description": "Session key ID of the session keys used to derive the root relay session key.", "type": "string", - "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", - "default": "RELAY_LIMIT_BUCKET_SIZE_1", - "enum": [ - "RELAY_LIMIT_BUCKET_SIZE_1", - "RELAY_LIMIT_BUCKET_SIZE_2", - "RELAY_LIMIT_BUCKET_SIZE_4", - "RELAY_LIMIT_BUCKET_SIZE_12" - ] + "format": "byte" + } + } + } + } + } + } + } + }, + "desired_rx1_data_rate_offset": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_OFFSET_0", + "enum": [ + "DATA_RATE_OFFSET_0", + "DATA_RATE_OFFSET_1", + "DATA_RATE_OFFSET_2", + "DATA_RATE_OFFSET_3", + "DATA_RATE_OFFSET_4", + "DATA_RATE_OFFSET_5", + "DATA_RATE_OFFSET_6", + "DATA_RATE_OFFSET_7" + ] + } + } + }, + "desired_rx1_delay": { + "type": "object", + "properties": { + "value": { + "description": " - RX_DELAY_0: 1 second.\n - RX_DELAY_1: 1 second.\n - RX_DELAY_2: 2 seconds.\n - RX_DELAY_3: 3 seconds.\n - RX_DELAY_4: 4 seconds.\n - RX_DELAY_5: 5 seconds.\n - RX_DELAY_6: 6 seconds.\n - RX_DELAY_7: 7 seconds.\n - RX_DELAY_8: 8 seconds.\n - RX_DELAY_9: 9 seconds.\n - RX_DELAY_10: 10 seconds.\n - RX_DELAY_11: 11 seconds.\n - RX_DELAY_12: 12 seconds.\n - RX_DELAY_13: 13 seconds.\n - RX_DELAY_14: 14 seconds.\n - RX_DELAY_15: 15 seconds.", + "type": "string", + "default": "RX_DELAY_0", + "enum": [ + "RX_DELAY_0", + "RX_DELAY_1", + "RX_DELAY_2", + "RX_DELAY_3", + "RX_DELAY_4", + "RX_DELAY_5", + "RX_DELAY_6", + "RX_DELAY_7", + "RX_DELAY_8", + "RX_DELAY_9", + "RX_DELAY_10", + "RX_DELAY_11", + "RX_DELAY_12", + "RX_DELAY_13", + "RX_DELAY_14", + "RX_DELAY_15" + ] + } + } + }, + "desired_rx2_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "desired_rx2_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "downlink_dwell_time": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "factory_preset_frequencies": { + "description": "List of factory-preset frequencies.\nIf unset, the default value from Network Server configuration or regional parameters specification will be used.", + "type": "array", + "items": { + "type": "string", + "format": "uint64" + } + }, + "max_duty_cycle": { + "type": "object", + "properties": { + "value": { + "description": " - DUTY_CYCLE_1: 100%.\n - DUTY_CYCLE_2: 50%.\n - DUTY_CYCLE_4: 25%.\n - DUTY_CYCLE_8: 12.5%.\n - DUTY_CYCLE_16: 6.25%.\n - DUTY_CYCLE_32: 3.125%.\n - DUTY_CYCLE_64: 1.5625%.\n - DUTY_CYCLE_128: Roughly 0.781%.\n - DUTY_CYCLE_256: Roughly 0.390%.\n - DUTY_CYCLE_512: Roughly 0.195%.\n - DUTY_CYCLE_1024: Roughly 0.098%.\n - DUTY_CYCLE_2048: Roughly 0.049%.\n - DUTY_CYCLE_4096: Roughly 0.024%.\n - DUTY_CYCLE_8192: Roughly 0.012%.\n - DUTY_CYCLE_16384: Roughly 0.006%.\n - DUTY_CYCLE_32768: Roughly 0.003%.", + "type": "string", + "default": "DUTY_CYCLE_1", + "enum": [ + "DUTY_CYCLE_1", + "DUTY_CYCLE_2", + "DUTY_CYCLE_4", + "DUTY_CYCLE_8", + "DUTY_CYCLE_16", + "DUTY_CYCLE_32", + "DUTY_CYCLE_64", + "DUTY_CYCLE_128", + "DUTY_CYCLE_256", + "DUTY_CYCLE_512", + "DUTY_CYCLE_1024", + "DUTY_CYCLE_2048", + "DUTY_CYCLE_4096", + "DUTY_CYCLE_8192", + "DUTY_CYCLE_16384", + "DUTY_CYCLE_32768" + ] + } + } + }, + "ping_slot_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "ping_slot_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "ping_slot_periodicity": { + "type": "object", + "properties": { + "value": { + "description": " - PING_EVERY_1S: Every second.\n - PING_EVERY_2S: Every 2 seconds.\n - PING_EVERY_4S: Every 4 seconds.\n - PING_EVERY_8S: Every 8 seconds.\n - PING_EVERY_16S: Every 16 seconds.\n - PING_EVERY_32S: Every 32 seconds.\n - PING_EVERY_64S: Every 64 seconds.\n - PING_EVERY_128S: Every 128 seconds.", + "type": "string", + "default": "PING_EVERY_1S", + "enum": [ + "PING_EVERY_1S", + "PING_EVERY_2S", + "PING_EVERY_4S", + "PING_EVERY_8S", + "PING_EVERY_16S", + "PING_EVERY_32S", + "PING_EVERY_64S", + "PING_EVERY_128S" + ] + } + } + }, + "relay": { + "description": "RelaySettings represent the settings of a relay.\nThis is used internally by the Network Server.", + "type": "object", + "properties": { + "served": { + "type": "object", + "properties": { + "always": { + "type": "object" + }, + "backoff": { + "description": "Number of wake on radio frames to be sent without an acknowledgement before sending the uplink message directly.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "dynamic": { + "type": "object", + "properties": { + "smart_enable_level": { + "type": "string", + "default": "RELAY_SMART_ENABLE_LEVEL_8", + "enum": [ + "RELAY_SMART_ENABLE_LEVEL_8", + "RELAY_SMART_ENABLE_LEVEL_16", + "RELAY_SMART_ENABLE_LEVEL_32", + "RELAY_SMART_ENABLE_LEVEL_64" + ] + } + } + }, + "end_device_controlled": { + "type": "object" + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "serving_device_id": { + "description": "End device identifier of the serving end device.", + "type": "string" + } + } + }, + "serving": { + "type": "object", + "properties": { + "cad_periodicity": { + "type": "string", + "title": "- RELAY_CAD_PERIODICITY_20_MILLISECONDS: sic", + "default": "RELAY_CAD_PERIODICITY_1_SECOND", + "enum": [ + "RELAY_CAD_PERIODICITY_1_SECOND", + "RELAY_CAD_PERIODICITY_500_MILLISECONDS", + "RELAY_CAD_PERIODICITY_250_MILLISECONDS", + "RELAY_CAD_PERIODICITY_100_MILLISECONDS", + "RELAY_CAD_PERIODICITY_50_MILLISECONDS", + "RELAY_CAD_PERIODICITY_20_MILLISECONDS" + ] + }, + "default_channel_index": { + "description": "Index of the default wake on radio channel.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "join_requests": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "notifications": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "overall": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "reset_behavior": { + "type": "string", + "default": "RELAY_RESET_LIMIT_COUNTER_ZERO", + "enum": [ + "RELAY_RESET_LIMIT_COUNTER_ZERO", + "RELAY_RESET_LIMIT_COUNTER_RELOAD_RATE", + "RELAY_RESET_LIMIT_COUNTER_MAX_VALUE", + "RELAY_RESET_LIMIT_COUNTER_NO_RESET" + ] + }, + "uplink_messages": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + } + } + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "uplink_forwarding_rules": { + "description": "Configured uplink forwarding rules.", + "type": "array", + "items": { + "type": "object", + "properties": { + "device_id": { + "description": "End device identifier of the served end device.", + "type": "string" }, - "reload_rate": { - "description": "The number of tokens which are replenished in the bucket every hour.", + "last_w_f_cnt": { + "description": "Last wake on radio frame counter used by the served end device.", "type": "integer", "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "session_key_id": { + "description": "Session key ID of the session keys used to derive the root relay session key.", + "type": "string", + "format": "byte" } } - }, - "session_key_id": { - "description": "Session key ID of the session keys used to derive the root relay session key.", - "type": "string", - "format": "byte" } } } } } + }, + "resets_f_cnt": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "rx1_data_rate_offset": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_OFFSET_0", + "enum": [ + "DATA_RATE_OFFSET_0", + "DATA_RATE_OFFSET_1", + "DATA_RATE_OFFSET_2", + "DATA_RATE_OFFSET_3", + "DATA_RATE_OFFSET_4", + "DATA_RATE_OFFSET_5", + "DATA_RATE_OFFSET_6", + "DATA_RATE_OFFSET_7" + ] + } + } + }, + "rx1_delay": { + "type": "object", + "properties": { + "value": { + "description": " - RX_DELAY_0: 1 second.\n - RX_DELAY_1: 1 second.\n - RX_DELAY_2: 2 seconds.\n - RX_DELAY_3: 3 seconds.\n - RX_DELAY_4: 4 seconds.\n - RX_DELAY_5: 5 seconds.\n - RX_DELAY_6: 6 seconds.\n - RX_DELAY_7: 7 seconds.\n - RX_DELAY_8: 8 seconds.\n - RX_DELAY_9: 9 seconds.\n - RX_DELAY_10: 10 seconds.\n - RX_DELAY_11: 11 seconds.\n - RX_DELAY_12: 12 seconds.\n - RX_DELAY_13: 13 seconds.\n - RX_DELAY_14: 14 seconds.\n - RX_DELAY_15: 15 seconds.", + "type": "string", + "default": "RX_DELAY_0", + "enum": [ + "RX_DELAY_0", + "RX_DELAY_1", + "RX_DELAY_2", + "RX_DELAY_3", + "RX_DELAY_4", + "RX_DELAY_5", + "RX_DELAY_6", + "RX_DELAY_7", + "RX_DELAY_8", + "RX_DELAY_9", + "RX_DELAY_10", + "RX_DELAY_11", + "RX_DELAY_12", + "RX_DELAY_13", + "RX_DELAY_14", + "RX_DELAY_15" + ] + } + } + }, + "rx2_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "rx2_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "schedule_downlinks": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "status_count_periodicity": { + "description": "Number of uplink messages after which a DevStatusReq MACCommand shall be sent.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "status_time_periodicity": { + "description": "The interval after which a DevStatusReq MACCommand shall be sent.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "supports_32_bit_f_cnt": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "uplink_dwell_time": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "use_adr": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } } } - }, - "resets_f_cnt": { - "type": "object", - "properties": { - "value": { - "type": "boolean" - } - } - }, - "rx1_data_rate_offset": { - "type": "object", - "properties": { - "value": { - "type": "string", - "default": "DATA_RATE_OFFSET_0", - "enum": [ - "DATA_RATE_OFFSET_0", - "DATA_RATE_OFFSET_1", - "DATA_RATE_OFFSET_2", - "DATA_RATE_OFFSET_3", - "DATA_RATE_OFFSET_4", - "DATA_RATE_OFFSET_5", - "DATA_RATE_OFFSET_6", - "DATA_RATE_OFFSET_7" - ] - } - } - }, - "rx1_delay": { - "type": "object", - "properties": { - "value": { - "description": " - RX_DELAY_0: 1 second.\n - RX_DELAY_1: 1 second.\n - RX_DELAY_2: 2 seconds.\n - RX_DELAY_3: 3 seconds.\n - RX_DELAY_4: 4 seconds.\n - RX_DELAY_5: 5 seconds.\n - RX_DELAY_6: 6 seconds.\n - RX_DELAY_7: 7 seconds.\n - RX_DELAY_8: 8 seconds.\n - RX_DELAY_9: 9 seconds.\n - RX_DELAY_10: 10 seconds.\n - RX_DELAY_11: 11 seconds.\n - RX_DELAY_12: 12 seconds.\n - RX_DELAY_13: 13 seconds.\n - RX_DELAY_14: 14 seconds.\n - RX_DELAY_15: 15 seconds.", - "type": "string", - "default": "RX_DELAY_0", - "enum": [ - "RX_DELAY_0", - "RX_DELAY_1", - "RX_DELAY_2", - "RX_DELAY_3", - "RX_DELAY_4", - "RX_DELAY_5", - "RX_DELAY_6", - "RX_DELAY_7", - "RX_DELAY_8", - "RX_DELAY_9", - "RX_DELAY_10", - "RX_DELAY_11", - "RX_DELAY_12", - "RX_DELAY_13", - "RX_DELAY_14", - "RX_DELAY_15" - ] - } - } - }, - "rx2_data_rate_index": { - "type": "object", - "properties": { - "value": { - "type": "string", - "default": "DATA_RATE_0", - "enum": [ - "DATA_RATE_0", - "DATA_RATE_1", - "DATA_RATE_2", - "DATA_RATE_3", - "DATA_RATE_4", - "DATA_RATE_5", - "DATA_RATE_6", - "DATA_RATE_7", - "DATA_RATE_8", - "DATA_RATE_9", - "DATA_RATE_10", - "DATA_RATE_11", - "DATA_RATE_12", - "DATA_RATE_13", - "DATA_RATE_14", - "DATA_RATE_15" - ] - } - } - }, - "rx2_frequency": { - "type": "object", - "properties": { - "value": { - "type": "string", - "format": "uint64" - } - } - }, - "schedule_downlinks": { + } + } + }, + "v3MACSettingsProfileIdentifiers": { + "type": "object", + "properties": { + "application_ids": { "type": "object", "properties": { - "value": { - "type": "boolean" + "application_id": { + "type": "string" } } }, - "status_count_periodicity": { - "description": "Number of uplink messages after which a DevStatusReq MACCommand shall be sent.\nIf unset, the default value from Network Server configuration will be used.", - "type": "integer", - "format": "int64" - }, - "status_time_periodicity": { - "description": "The interval after which a DevStatusReq MACCommand shall be sent.\nIf unset, the default value from Network Server configuration will be used.", + "profile_id": { + "description": "Profile ID.", "type": "string" - }, - "supports_32_bit_f_cnt": { - "type": "object", - "properties": { - "value": { - "type": "boolean" - } - } - }, - "uplink_dwell_time": { - "type": "object", - "properties": { - "value": { - "type": "boolean" - } - } - }, - "use_adr": { - "type": "object", - "properties": { - "value": { - "type": "boolean" - } - } } } }, @@ -644335,7 +664320,7 @@ "type": "string" }, "notification_type": { - "description": "The type of this notification.", + "description": "The type of this notification.\nTODO: Replace with type NotificationType in v4 https://github.com/TheThingsNetwork/lorawan-stack/issues/7384.", "type": "string" }, "receivers": { @@ -644402,6 +664387,25 @@ "NOTIFICATION_STATUS_ARCHIVED" ] }, + "v3NotificationType": { + "type": "string", + "default": "UNKNOWN", + "enum": [ + "UNKNOWN", + "API_KEY_CREATED", + "API_KEY_CHANGED", + "CLIENT_REQUESTED", + "COLLABORATOR_CHANGED", + "ENTITY_STATE_CHANGED", + "INVITATION", + "LOGIN_TOKEN", + "PASSWORD_CHANGED", + "TEMPORARY_PASSWORD", + "USER_REQUESTED", + "VALIDATE", + "SUPPORT_ACCESS_REQUESTED" + ] + }, "v3NsEndDeviceRegistrySetBody": { "type": "object", "properties": { @@ -655222,528 +675226,2789 @@ } } }, - "tx_param_setup_req": { + "tx_param_setup_req": { + "type": "object", + "properties": { + "downlink_dwell_time": { + "type": "boolean" + }, + "max_eirp_index": { + "description": " - DEVICE_EIRP_8: 8 dBm.\n - DEVICE_EIRP_10: 10 dBm.\n - DEVICE_EIRP_12: 12 dBm.\n - DEVICE_EIRP_13: 13 dBm.\n - DEVICE_EIRP_14: 14 dBm.\n - DEVICE_EIRP_16: 16 dBm.\n - DEVICE_EIRP_18: 18 dBm.\n - DEVICE_EIRP_20: 20 dBm.\n - DEVICE_EIRP_21: 21 dBm.\n - DEVICE_EIRP_24: 24 dBm.\n - DEVICE_EIRP_26: 26 dBm.\n - DEVICE_EIRP_27: 27 dBm.\n - DEVICE_EIRP_29: 29 dBm.\n - DEVICE_EIRP_30: 30 dBm.\n - DEVICE_EIRP_33: 33 dBm.\n - DEVICE_EIRP_36: 36 dBm.", + "type": "string", + "default": "DEVICE_EIRP_8", + "enum": [ + "DEVICE_EIRP_8", + "DEVICE_EIRP_10", + "DEVICE_EIRP_12", + "DEVICE_EIRP_13", + "DEVICE_EIRP_14", + "DEVICE_EIRP_16", + "DEVICE_EIRP_18", + "DEVICE_EIRP_20", + "DEVICE_EIRP_21", + "DEVICE_EIRP_24", + "DEVICE_EIRP_26", + "DEVICE_EIRP_27", + "DEVICE_EIRP_29", + "DEVICE_EIRP_30", + "DEVICE_EIRP_33", + "DEVICE_EIRP_36" + ] + }, + "uplink_dwell_time": { + "type": "boolean" + } + } + } + } + } + }, + "recent_downlinks": { + "description": "Recent data downlink messages sorted by time.\nThe number of messages stored may depend on configuration.", + "type": "array", + "items": { + "description": "A minimal DownlinkMessage definition which is binary compatible with the top level DownlinkMessage message.\nUsed for type safe recent downlink storage.", + "type": "object", + "properties": { + "correlation_ids": { + "type": "array", + "items": { + "type": "string" + } + }, + "payload": { + "type": "object", + "properties": { + "m_hdr": { + "type": "object", + "properties": { + "m_type": { + "type": "string", + "default": "JOIN_REQUEST", + "enum": [ + "JOIN_REQUEST", + "JOIN_ACCEPT", + "UNCONFIRMED_UP", + "UNCONFIRMED_DOWN", + "CONFIRMED_UP", + "CONFIRMED_DOWN", + "REJOIN_REQUEST", + "PROPRIETARY" + ] + } + } + }, + "mac_payload": { + "type": "object", + "properties": { + "f_port": { + "type": "integer", + "format": "int64" + }, + "full_f_cnt": { + "type": "integer", + "format": "int64" + } + } + } + } + } + } + } + }, + "recent_mac_command_identifiers": { + "description": "MAC command identifiers sent by the end device in the last received uplink.\nThe Network Server may choose to store only certain types of MAC\ncommand identifiers in the underlying implementation.", + "type": "array", + "items": { + "type": "string", + "title": "- CID_BEACON_TIMING: Deprecated", + "default": "CID_RFU_0", + "enum": [ + "CID_RFU_0", + "CID_RESET", + "CID_LINK_CHECK", + "CID_LINK_ADR", + "CID_DUTY_CYCLE", + "CID_RX_PARAM_SETUP", + "CID_DEV_STATUS", + "CID_NEW_CHANNEL", + "CID_RX_TIMING_SETUP", + "CID_TX_PARAM_SETUP", + "CID_DL_CHANNEL", + "CID_REKEY", + "CID_ADR_PARAM_SETUP", + "CID_DEVICE_TIME", + "CID_FORCE_REJOIN", + "CID_REJOIN_PARAM_SETUP", + "CID_PING_SLOT_INFO", + "CID_PING_SLOT_CHANNEL", + "CID_BEACON_TIMING", + "CID_BEACON_FREQ", + "CID_DEVICE_MODE", + "CID_RELAY_CONF", + "CID_RELAY_END_DEVICE_CONF", + "CID_RELAY_FILTER_LIST", + "CID_RELAY_UPDATE_UPLINK_LIST", + "CID_RELAY_CTRL_UPLINK_LIST", + "CID_RELAY_CONFIGURE_FWD_LIMIT", + "CID_RELAY_NOTIFY_NEW_END_DEVICE" + ] + } + }, + "recent_uplinks": { + "description": "Recent data uplink messages sorted by time.\nThe number of messages stored may depend on configuration.", + "type": "array", + "items": { + "description": "A minimal UplinkMessage definition which is binary compatible with the top level UplinkMessage message.\nUsed for type safe recent uplink storage.", + "type": "object", + "properties": { + "correlation_ids": { + "type": "array", + "items": { + "type": "string" + } + }, + "device_channel_index": { + "type": "integer", + "format": "int64" + }, + "payload": { + "type": "object", + "title": "Message represents a LoRaWAN message", + "properties": { + "join_accept_payload": { + "type": "object", + "properties": { + "cf_list": { + "type": "object", + "properties": { + "ch_masks": { + "description": "ChMasks controlling the channels to be used.\nLength of this field must be equal to the amount of uplink channels\ndefined by the selected frequency plan.", + "type": "array", + "items": { + "type": "boolean" + } + }, + "freq": { + "description": "Frequencies to be broadcasted, in hecto-Hz.\nThese values are broadcasted as 24 bits unsigned integers.\nThis field should not contain default values.", + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + }, + "type": { + "type": "string", + "default": "FREQUENCIES", + "enum": [ + "FREQUENCIES", + "CHANNEL_MASKS" + ] + } + } + }, + "dev_addr": { + "type": "string", + "format": "string", + "example": "2600ABCD" + }, + "dl_settings": { + "type": "object", + "properties": { + "opt_neg": { + "description": "OptNeg is set if Network Server implements LoRaWAN 1.1 or greater.", + "type": "boolean" + }, + "rx1_dr_offset": { + "type": "string", + "default": "DATA_RATE_OFFSET_0", + "enum": [ + "DATA_RATE_OFFSET_0", + "DATA_RATE_OFFSET_1", + "DATA_RATE_OFFSET_2", + "DATA_RATE_OFFSET_3", + "DATA_RATE_OFFSET_4", + "DATA_RATE_OFFSET_5", + "DATA_RATE_OFFSET_6", + "DATA_RATE_OFFSET_7" + ] + }, + "rx2_dr": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "encrypted": { + "type": "string", + "format": "byte" + }, + "join_nonce": { + "type": "string", + "format": "string", + "example": "ABCDEF" + }, + "net_id": { + "type": "string", + "format": "string", + "example": "000013" + }, + "rx_delay": { + "description": " - RX_DELAY_0: 1 second.\n - RX_DELAY_1: 1 second.\n - RX_DELAY_2: 2 seconds.\n - RX_DELAY_3: 3 seconds.\n - RX_DELAY_4: 4 seconds.\n - RX_DELAY_5: 5 seconds.\n - RX_DELAY_6: 6 seconds.\n - RX_DELAY_7: 7 seconds.\n - RX_DELAY_8: 8 seconds.\n - RX_DELAY_9: 9 seconds.\n - RX_DELAY_10: 10 seconds.\n - RX_DELAY_11: 11 seconds.\n - RX_DELAY_12: 12 seconds.\n - RX_DELAY_13: 13 seconds.\n - RX_DELAY_14: 14 seconds.\n - RX_DELAY_15: 15 seconds.", + "type": "string", + "default": "RX_DELAY_0", + "enum": [ + "RX_DELAY_0", + "RX_DELAY_1", + "RX_DELAY_2", + "RX_DELAY_3", + "RX_DELAY_4", + "RX_DELAY_5", + "RX_DELAY_6", + "RX_DELAY_7", + "RX_DELAY_8", + "RX_DELAY_9", + "RX_DELAY_10", + "RX_DELAY_11", + "RX_DELAY_12", + "RX_DELAY_13", + "RX_DELAY_14", + "RX_DELAY_15" + ] + } + } + }, + "join_request_payload": { + "type": "object", + "properties": { + "dev_eui": { + "type": "string", + "format": "string", + "example": "70B3D57ED000ABCD" + }, + "dev_nonce": { + "type": "string", + "format": "string", + "example": "ABCD" + }, + "join_eui": { + "type": "string", + "format": "string", + "example": "70B3D57ED000ABCD" + } + } + }, + "m_hdr": { + "type": "object", + "properties": { + "m_type": { + "type": "string", + "default": "JOIN_REQUEST", + "enum": [ + "JOIN_REQUEST", + "JOIN_ACCEPT", + "UNCONFIRMED_UP", + "UNCONFIRMED_DOWN", + "CONFIRMED_UP", + "CONFIRMED_DOWN", + "REJOIN_REQUEST", + "PROPRIETARY" + ] + }, + "major": { + "type": "string", + "default": "LORAWAN_R1", + "enum": [ + "LORAWAN_R1" + ] + } + } + }, + "mac_payload": { + "type": "object", + "properties": { + "decoded_payload": { + "type": "object" + }, + "f_hdr": { + "type": "object", + "properties": { + "dev_addr": { + "type": "string", + "format": "string", + "example": "2600ABCD" + }, + "f_cnt": { + "type": "integer", + "format": "int64" + }, + "f_ctrl": { + "type": "object", + "properties": { + "ack": { + "type": "boolean" + }, + "adr": { + "type": "boolean" + }, + "adr_ack_req": { + "description": "Only on uplink.", + "type": "boolean" + }, + "class_b": { + "description": "Only on uplink.", + "type": "boolean" + }, + "f_pending": { + "description": "Only on downlink.", + "type": "boolean" + } + } + }, + "f_opts": { + "type": "string", + "format": "byte" + } + } + }, + "f_port": { + "type": "integer", + "format": "int64" + }, + "frm_payload": { + "type": "string", + "format": "byte" + }, + "full_f_cnt": { + "description": "Full 32-bit FCnt value. Used internally by Network Server.", + "type": "integer", + "format": "int64" + } + } + }, + "mic": { + "type": "string", + "format": "byte" + }, + "rejoin_request_payload": { + "type": "object", + "properties": { + "dev_eui": { + "type": "string", + "format": "string", + "example": "70B3D57ED000ABCD" + }, + "join_eui": { + "type": "string", + "format": "string", + "example": "70B3D57ED000ABCD" + }, + "net_id": { + "type": "string", + "format": "string", + "example": "000013" + }, + "rejoin_cnt": { + "description": "Contains RJCount0 or RJCount1 depending on rejoin_type.", + "type": "integer", + "format": "int64" + }, + "rejoin_type": { + "description": " - CONTEXT: Resets DevAddr, Session Keys, Frame Counters, Radio Parameters.\n - SESSION: Equivalent to the initial JoinRequest.\n - KEYS: Resets DevAddr, Session Keys, Frame Counters, while keeping the Radio Parameters.", + "type": "string", + "default": "CONTEXT", + "enum": [ + "CONTEXT", + "SESSION", + "KEYS" + ] + } + } + } + } + }, + "received_at": { + "type": "string", + "format": "date-time" + }, + "rx_metadata": { + "type": "array", + "items": { + "type": "object", + "properties": { + "channel_rssi": { + "type": "number", + "format": "float" + }, + "downlink_path_constraint": { + "description": " - DOWNLINK_PATH_CONSTRAINT_NONE: Indicates that the gateway can be selected for downlink without constraints by the Network Server.\n - DOWNLINK_PATH_CONSTRAINT_PREFER_OTHER: Indicates that the gateway can be selected for downlink only if no other or better gateway can be selected.\n - DOWNLINK_PATH_CONSTRAINT_NEVER: Indicates that this gateway will never be selected for downlink, even if that results in no available downlink path.", + "type": "string", + "default": "DOWNLINK_PATH_CONSTRAINT_NONE", + "enum": [ + "DOWNLINK_PATH_CONSTRAINT_NONE", + "DOWNLINK_PATH_CONSTRAINT_PREFER_OTHER", + "DOWNLINK_PATH_CONSTRAINT_NEVER" + ] + }, + "gateway_ids": { + "type": "object", + "properties": { + "eui": { + "description": "Secondary identifier, which can only be used in specific requests.", + "type": "string", + "format": "string", + "example": "70B3D57ED000ABCD" + }, + "gateway_id": { + "type": "string" + } + } + }, + "packet_broker": { + "type": "object" + }, + "relay": { + "type": "object" + }, + "snr": { + "type": "number", + "format": "float" + }, + "uplink_token": { + "type": "string", + "format": "byte" + } + } + } + }, + "settings": { + "type": "object", + "properties": { + "data_rate": { + "type": "object", + "properties": { + "fsk": { + "type": "object", + "properties": { + "bit_rate": { + "description": "Bit rate (bps).", + "type": "integer", + "format": "int64" + } + } + }, + "lora": { + "type": "object", + "properties": { + "bandwidth": { + "description": "Bandwidth (Hz).", + "type": "integer", + "format": "int64" + }, + "coding_rate": { + "type": "string" + }, + "spreading_factor": { + "type": "integer", + "format": "int64" + } + } + }, + "lrfhss": { + "type": "object", + "properties": { + "coding_rate": { + "type": "string" + }, + "modulation_type": { + "type": "integer", + "format": "int64" + }, + "operating_channel_width": { + "description": "Operating Channel Width (Hz).", + "type": "integer", + "format": "int64" + } + } + } + } + } + } + } + } + } + }, + "rejected_adr_data_rate_indexes": { + "description": "ADR Data rate index values rejected by the device.\nReset each time `current_parameters.channels` change.\nElements are sorted in ascending order.", + "type": "array", + "items": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + }, + "rejected_adr_tx_power_indexes": { + "description": "ADR TX output power index values rejected by the device.\nElements are sorted in ascending order.", + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + }, + "rejected_data_rate_ranges": { + "description": "Data rate ranges rejected by the device per frequency.", + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "ranges": { + "type": "array", + "items": { + "type": "object", + "properties": { + "max_data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "min_data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + } + } + } + } + }, + "rejected_frequencies": { + "description": "Frequencies rejected by the device.", + "type": "array", + "items": { + "type": "string", + "format": "uint64" + } + }, + "rx_windows_available": { + "description": "Whether or not Rx windows are expected to be open.\nSet to true every time an uplink is received.\nSet to false every time a successful downlink scheduling attempt is made.", + "type": "boolean" + } + } + }, + "pending_session": { + "type": "object", + "properties": { + "dev_addr": { + "description": "Device Address, issued by the Network Server or chosen by device manufacturer in case of testing range (beginning with 00-03).\nKnown by Network Server, Application Server and Join Server. Owned by Network Server.", + "type": "string", + "format": "string", + "example": "2600ABCD" + }, + "keys": { + "description": "Session keys for a LoRaWAN session.\nOnly the components for which the keys were meant, will have the key-encryption-key (KEK) to decrypt the individual keys.", + "type": "object", + "properties": { + "app_s_key": { + "type": "object", + "properties": { + "encrypted_key": { + "type": "string", + "format": "byte" + }, + "kek_label": { + "description": "The label of the RFC 3394 key-encryption-key (KEK) that was used to encrypt the key.", + "type": "string" + }, + "key": { + "description": "The unencrypted AES key.", + "type": "string", + "format": "string", + "example": "0123456789ABCDEF0123456789ABCDEF" + } + } + }, + "f_nwk_s_int_key": { + "type": "object", + "properties": { + "encrypted_key": { + "type": "string", + "format": "byte" + }, + "kek_label": { + "description": "The label of the RFC 3394 key-encryption-key (KEK) that was used to encrypt the key.", + "type": "string" + }, + "key": { + "description": "The unencrypted AES key.", + "type": "string", + "format": "string", + "example": "0123456789ABCDEF0123456789ABCDEF" + } + } + }, + "nwk_s_enc_key": { + "type": "object", + "properties": { + "encrypted_key": { + "type": "string", + "format": "byte" + }, + "kek_label": { + "description": "The label of the RFC 3394 key-encryption-key (KEK) that was used to encrypt the key.", + "type": "string" + }, + "key": { + "description": "The unencrypted AES key.", + "type": "string", + "format": "string", + "example": "0123456789ABCDEF0123456789ABCDEF" + } + } + }, + "s_nwk_s_int_key": { + "type": "object", + "properties": { + "encrypted_key": { + "type": "string", + "format": "byte" + }, + "kek_label": { + "description": "The label of the RFC 3394 key-encryption-key (KEK) that was used to encrypt the key.", + "type": "string" + }, + "key": { + "description": "The unencrypted AES key.", + "type": "string", + "format": "string", + "example": "0123456789ABCDEF0123456789ABCDEF" + } + } + }, + "session_key_id": { + "description": "Join Server issued identifier for the session keys.\nThis ID can be used to request the keys from the Join Server in case the are lost.", + "type": "string", + "format": "byte" + } + } + }, + "last_a_f_cnt_down": { + "description": "Last application downlink frame counter value used. Application Server only.", + "type": "integer", + "format": "int64" + }, + "last_conf_f_cnt_down": { + "description": "Frame counter of the last confirmed downlink message sent. Network Server only.", + "type": "integer", + "format": "int64" + }, + "last_f_cnt_up": { + "description": "Last uplink frame counter value used. Network Server only. Application Server assumes the Network Server checked it.", + "type": "integer", + "format": "int64" + }, + "last_n_f_cnt_down": { + "description": "Last network downlink frame counter value used. Network Server only.", + "type": "integer", + "format": "int64" + }, + "queued_application_downlinks": { + "description": "Queued Application downlink messages. Stored in Application Server and Network Server.", + "type": "array", + "items": { + "type": "object", + "properties": { + "class_b_c": { + "type": "object", + "properties": { + "absolute_time": { + "description": "Absolute time when the downlink message should be transmitted.\nThis requires the gateway to have GPS time synchronization.\nIf the time is in the past or if there is a scheduling conflict, the downlink message fails.\nIf null, the time is selected based on slot availability. This is recommended in class B mode.", + "type": "string", + "format": "date-time" + }, + "gateways": { + "description": "Possible gateway identifiers, antenna index, and group index to use for this downlink message.\nThe Network Server selects one of these gateways for downlink, based on connectivity, signal quality, channel utilization and an available slot.\nIf none of the gateways can be selected, the downlink message fails.\nIf empty, a gateway and antenna is selected automatically from the gateways seen in recent uplinks.\nIf group index is set, gateways will be grouped by the index for the Network Server to select one gateway per group.", + "type": "array", + "items": { + "type": "object", + "properties": { + "antenna_index": { + "type": "integer", + "format": "int64" + }, + "gateway_ids": { + "type": "object", + "properties": { + "eui": { + "description": "Secondary identifier, which can only be used in specific requests.", + "type": "string", + "format": "string", + "example": "70B3D57ED000ABCD" + }, + "gateway_id": { + "type": "string" + } + } + }, + "group_index": { + "type": "integer", + "format": "int64" + } + } + } + } + } + }, + "confirmed": { + "type": "boolean" + }, + "confirmed_retry": { + "type": "object", + "properties": { + "attempt": { + "description": "The number of attempted confirmed downlink acknowledgements.", + "type": "integer", + "format": "int64" + }, + "max_attempts": { + "description": "The maximum number of confirmed downlink acknowledgement attempts.\nIf null, the Application Server configuration is used instead.", + "type": "integer", + "format": "int64" + } + } + }, + "correlation_ids": { + "type": "array", + "items": { + "type": "string" + } + }, + "decoded_payload": { + "description": "The decoded frame payload of the downlink message.\nWhen scheduling downlink with a message processor configured for the end device (see formatters) or application (see default_formatters),\nthis fields acts as input for the downlink encoder, and the output is set to frm_payload.\nWhen reading downlink (listing the queue, downlink message events, etc), this fields acts as output of the downlink decoder, and the input is frm_payload.", + "type": "object" + }, + "decoded_payload_warnings": { + "description": "Warnings generated by the message processor while encoding frm_payload (scheduling downlink) or decoding the frm_payload (reading downlink).", + "type": "array", + "items": { + "type": "string" + } + }, + "f_cnt": { + "type": "integer", + "format": "int64" + }, + "f_port": { + "type": "integer", + "format": "int64" + }, + "frm_payload": { + "description": "The frame payload of the downlink message.\nThe payload is encrypted if the skip_payload_crypto field of the EndDevice\nis true.", + "type": "string", + "format": "byte" + }, + "priority": { + "type": "string", + "default": "LOWEST", + "enum": [ + "LOWEST", + "LOW", + "BELOW_NORMAL", + "NORMAL", + "ABOVE_NORMAL", + "HIGH", + "HIGHEST" + ] + }, + "session_key_id": { + "description": "Join Server issued identifier for the session keys used by this downlink.", + "type": "string", + "format": "byte" + } + } + } + }, + "started_at": { + "description": "Time when the session started. Network Server only.", + "type": "string", + "format": "date-time" + } + } + }, + "picture": { + "type": "object", + "properties": { + "embedded": { + "type": "object", + "properties": { + "data": { + "description": "Picture data. A data URI can be constructed as follows:\n`data:\u003cmime_type\u003e;base64,\u003cdata\u003e`.", + "type": "string", + "format": "byte" + }, + "mime_type": { + "description": "MIME type of the picture.", + "type": "string" + } + } + }, + "sizes": { + "description": "URLs of the picture for different sizes, if available on a CDN.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "power_state": { + "description": "Power state of the device.", + "type": "string", + "default": "POWER_UNKNOWN", + "enum": [ + "POWER_UNKNOWN", + "POWER_BATTERY", + "POWER_EXTERNAL" + ] + }, + "provisioner_id": { + "description": "ID of the provisioner. Stored in Join Server.", + "type": "string" + }, + "provisioning_data": { + "description": "Vendor-specific provisioning data. Stored in Join Server.", + "type": "object" + }, + "queued_application_downlinks": { + "description": "Queued Application downlink messages. Stored in Application Server,\nwhich sets them on the Network Server.\nThis field is deprecated and is always set equal to session.queued_application_downlinks.", + "type": "array", + "items": { + "type": "object", + "properties": { + "class_b_c": { + "type": "object", + "properties": { + "absolute_time": { + "description": "Absolute time when the downlink message should be transmitted.\nThis requires the gateway to have GPS time synchronization.\nIf the time is in the past or if there is a scheduling conflict, the downlink message fails.\nIf null, the time is selected based on slot availability. This is recommended in class B mode.", + "type": "string", + "format": "date-time" + }, + "gateways": { + "description": "Possible gateway identifiers, antenna index, and group index to use for this downlink message.\nThe Network Server selects one of these gateways for downlink, based on connectivity, signal quality, channel utilization and an available slot.\nIf none of the gateways can be selected, the downlink message fails.\nIf empty, a gateway and antenna is selected automatically from the gateways seen in recent uplinks.\nIf group index is set, gateways will be grouped by the index for the Network Server to select one gateway per group.", + "type": "array", + "items": { + "type": "object", + "properties": { + "antenna_index": { + "type": "integer", + "format": "int64" + }, + "gateway_ids": { + "type": "object", + "properties": { + "eui": { + "description": "Secondary identifier, which can only be used in specific requests.", + "type": "string", + "format": "string", + "example": "70B3D57ED000ABCD" + }, + "gateway_id": { + "type": "string" + } + } + }, + "group_index": { + "type": "integer", + "format": "int64" + } + } + } + } + } + }, + "confirmed": { + "type": "boolean" + }, + "confirmed_retry": { + "type": "object", + "properties": { + "attempt": { + "description": "The number of attempted confirmed downlink acknowledgements.", + "type": "integer", + "format": "int64" + }, + "max_attempts": { + "description": "The maximum number of confirmed downlink acknowledgement attempts.\nIf null, the Application Server configuration is used instead.", + "type": "integer", + "format": "int64" + } + } + }, + "correlation_ids": { + "type": "array", + "items": { + "type": "string" + } + }, + "decoded_payload": { + "description": "The decoded frame payload of the downlink message.\nWhen scheduling downlink with a message processor configured for the end device (see formatters) or application (see default_formatters),\nthis fields acts as input for the downlink encoder, and the output is set to frm_payload.\nWhen reading downlink (listing the queue, downlink message events, etc), this fields acts as output of the downlink decoder, and the input is frm_payload.", + "type": "object" + }, + "decoded_payload_warnings": { + "description": "Warnings generated by the message processor while encoding frm_payload (scheduling downlink) or decoding the frm_payload (reading downlink).", + "type": "array", + "items": { + "type": "string" + } + }, + "f_cnt": { + "type": "integer", + "format": "int64" + }, + "f_port": { + "type": "integer", + "format": "int64" + }, + "frm_payload": { + "description": "The frame payload of the downlink message.\nThe payload is encrypted if the skip_payload_crypto field of the EndDevice\nis true.", + "type": "string", + "format": "byte" + }, + "priority": { + "type": "string", + "default": "LOWEST", + "enum": [ + "LOWEST", + "LOW", + "BELOW_NORMAL", + "NORMAL", + "ABOVE_NORMAL", + "HIGH", + "HIGHEST" + ] + }, + "session_key_id": { + "description": "Join Server issued identifier for the session keys used by this downlink.", + "type": "string", + "format": "byte" + } + } + } + }, + "resets_join_nonces": { + "description": "Whether the device resets the join and dev nonces (not LoRaWAN compliant). Stored in Join Server.\nCopied on creation from template identified by version_ids, if any or from the home Network Server device profile, if any.", + "type": "boolean" + }, + "root_keys": { + "description": "Root keys for a LoRaWAN device.\nThese are stored on the Join Server.", + "type": "object", + "properties": { + "app_key": { + "type": "object", + "properties": { + "encrypted_key": { + "type": "string", + "format": "byte" + }, + "kek_label": { + "description": "The label of the RFC 3394 key-encryption-key (KEK) that was used to encrypt the key.", + "type": "string" + }, + "key": { + "description": "The unencrypted AES key.", + "type": "string", + "format": "string", + "example": "0123456789ABCDEF0123456789ABCDEF" + } + } + }, + "nwk_key": { + "type": "object", + "properties": { + "encrypted_key": { + "type": "string", + "format": "byte" + }, + "kek_label": { + "description": "The label of the RFC 3394 key-encryption-key (KEK) that was used to encrypt the key.", + "type": "string" + }, + "key": { + "description": "The unencrypted AES key.", + "type": "string", + "format": "string", + "example": "0123456789ABCDEF0123456789ABCDEF" + } + } + }, + "root_key_id": { + "description": "Join Server issued identifier for the root keys.", + "type": "string" + } + } + }, + "serial_number": { + "type": "string" + }, + "service_profile_id": { + "description": "Default service profile. Stored in Entity Registry.", + "type": "string" + }, + "session": { + "type": "object", + "properties": { + "dev_addr": { + "description": "Device Address, issued by the Network Server or chosen by device manufacturer in case of testing range (beginning with 00-03).\nKnown by Network Server, Application Server and Join Server. Owned by Network Server.", + "type": "string", + "format": "string", + "example": "2600ABCD" + }, + "keys": { + "description": "Session keys for a LoRaWAN session.\nOnly the components for which the keys were meant, will have the key-encryption-key (KEK) to decrypt the individual keys.", + "type": "object", + "properties": { + "app_s_key": { + "type": "object", + "properties": { + "encrypted_key": { + "type": "string", + "format": "byte" + }, + "kek_label": { + "description": "The label of the RFC 3394 key-encryption-key (KEK) that was used to encrypt the key.", + "type": "string" + }, + "key": { + "description": "The unencrypted AES key.", + "type": "string", + "format": "string", + "example": "0123456789ABCDEF0123456789ABCDEF" + } + } + }, + "f_nwk_s_int_key": { + "type": "object", + "properties": { + "encrypted_key": { + "type": "string", + "format": "byte" + }, + "kek_label": { + "description": "The label of the RFC 3394 key-encryption-key (KEK) that was used to encrypt the key.", + "type": "string" + }, + "key": { + "description": "The unencrypted AES key.", + "type": "string", + "format": "string", + "example": "0123456789ABCDEF0123456789ABCDEF" + } + } + }, + "nwk_s_enc_key": { + "type": "object", + "properties": { + "encrypted_key": { + "type": "string", + "format": "byte" + }, + "kek_label": { + "description": "The label of the RFC 3394 key-encryption-key (KEK) that was used to encrypt the key.", + "type": "string" + }, + "key": { + "description": "The unencrypted AES key.", + "type": "string", + "format": "string", + "example": "0123456789ABCDEF0123456789ABCDEF" + } + } + }, + "s_nwk_s_int_key": { + "type": "object", + "properties": { + "encrypted_key": { + "type": "string", + "format": "byte" + }, + "kek_label": { + "description": "The label of the RFC 3394 key-encryption-key (KEK) that was used to encrypt the key.", + "type": "string" + }, + "key": { + "description": "The unencrypted AES key.", + "type": "string", + "format": "string", + "example": "0123456789ABCDEF0123456789ABCDEF" + } + } + }, + "session_key_id": { + "description": "Join Server issued identifier for the session keys.\nThis ID can be used to request the keys from the Join Server in case the are lost.", + "type": "string", + "format": "byte" + } + } + }, + "last_a_f_cnt_down": { + "description": "Last application downlink frame counter value used. Application Server only.", + "type": "integer", + "format": "int64" + }, + "last_conf_f_cnt_down": { + "description": "Frame counter of the last confirmed downlink message sent. Network Server only.", + "type": "integer", + "format": "int64" + }, + "last_f_cnt_up": { + "description": "Last uplink frame counter value used. Network Server only. Application Server assumes the Network Server checked it.", + "type": "integer", + "format": "int64" + }, + "last_n_f_cnt_down": { + "description": "Last network downlink frame counter value used. Network Server only.", + "type": "integer", + "format": "int64" + }, + "queued_application_downlinks": { + "description": "Queued Application downlink messages. Stored in Application Server and Network Server.", + "type": "array", + "items": { + "type": "object", + "properties": { + "class_b_c": { + "type": "object", + "properties": { + "absolute_time": { + "description": "Absolute time when the downlink message should be transmitted.\nThis requires the gateway to have GPS time synchronization.\nIf the time is in the past or if there is a scheduling conflict, the downlink message fails.\nIf null, the time is selected based on slot availability. This is recommended in class B mode.", + "type": "string", + "format": "date-time" + }, + "gateways": { + "description": "Possible gateway identifiers, antenna index, and group index to use for this downlink message.\nThe Network Server selects one of these gateways for downlink, based on connectivity, signal quality, channel utilization and an available slot.\nIf none of the gateways can be selected, the downlink message fails.\nIf empty, a gateway and antenna is selected automatically from the gateways seen in recent uplinks.\nIf group index is set, gateways will be grouped by the index for the Network Server to select one gateway per group.", + "type": "array", + "items": { + "type": "object", + "properties": { + "antenna_index": { + "type": "integer", + "format": "int64" + }, + "gateway_ids": { + "type": "object", + "properties": { + "eui": { + "description": "Secondary identifier, which can only be used in specific requests.", + "type": "string", + "format": "string", + "example": "70B3D57ED000ABCD" + }, + "gateway_id": { + "type": "string" + } + } + }, + "group_index": { + "type": "integer", + "format": "int64" + } + } + } + } + } + }, + "confirmed": { + "type": "boolean" + }, + "confirmed_retry": { "type": "object", "properties": { - "downlink_dwell_time": { - "type": "boolean" - }, - "max_eirp_index": { - "description": " - DEVICE_EIRP_8: 8 dBm.\n - DEVICE_EIRP_10: 10 dBm.\n - DEVICE_EIRP_12: 12 dBm.\n - DEVICE_EIRP_13: 13 dBm.\n - DEVICE_EIRP_14: 14 dBm.\n - DEVICE_EIRP_16: 16 dBm.\n - DEVICE_EIRP_18: 18 dBm.\n - DEVICE_EIRP_20: 20 dBm.\n - DEVICE_EIRP_21: 21 dBm.\n - DEVICE_EIRP_24: 24 dBm.\n - DEVICE_EIRP_26: 26 dBm.\n - DEVICE_EIRP_27: 27 dBm.\n - DEVICE_EIRP_29: 29 dBm.\n - DEVICE_EIRP_30: 30 dBm.\n - DEVICE_EIRP_33: 33 dBm.\n - DEVICE_EIRP_36: 36 dBm.", - "type": "string", - "default": "DEVICE_EIRP_8", - "enum": [ - "DEVICE_EIRP_8", - "DEVICE_EIRP_10", - "DEVICE_EIRP_12", - "DEVICE_EIRP_13", - "DEVICE_EIRP_14", - "DEVICE_EIRP_16", - "DEVICE_EIRP_18", - "DEVICE_EIRP_20", - "DEVICE_EIRP_21", - "DEVICE_EIRP_24", - "DEVICE_EIRP_26", - "DEVICE_EIRP_27", - "DEVICE_EIRP_29", - "DEVICE_EIRP_30", - "DEVICE_EIRP_33", - "DEVICE_EIRP_36" - ] + "attempt": { + "description": "The number of attempted confirmed downlink acknowledgements.", + "type": "integer", + "format": "int64" }, - "uplink_dwell_time": { - "type": "boolean" + "max_attempts": { + "description": "The maximum number of confirmed downlink acknowledgement attempts.\nIf null, the Application Server configuration is used instead.", + "type": "integer", + "format": "int64" } } - } - } - } - }, - "recent_downlinks": { - "description": "Recent data downlink messages sorted by time.\nThe number of messages stored may depend on configuration.", - "type": "array", - "items": { - "description": "A minimal DownlinkMessage definition which is binary compatible with the top level DownlinkMessage message.\nUsed for type safe recent downlink storage.", - "type": "object", - "properties": { + }, "correlation_ids": { "type": "array", "items": { "type": "string" } }, - "payload": { - "type": "object", - "properties": { - "m_hdr": { - "type": "object", - "properties": { - "m_type": { - "type": "string", - "default": "JOIN_REQUEST", - "enum": [ - "JOIN_REQUEST", - "JOIN_ACCEPT", - "UNCONFIRMED_UP", - "UNCONFIRMED_DOWN", - "CONFIRMED_UP", - "CONFIRMED_DOWN", - "REJOIN_REQUEST", - "PROPRIETARY" - ] - } + "decoded_payload": { + "description": "The decoded frame payload of the downlink message.\nWhen scheduling downlink with a message processor configured for the end device (see formatters) or application (see default_formatters),\nthis fields acts as input for the downlink encoder, and the output is set to frm_payload.\nWhen reading downlink (listing the queue, downlink message events, etc), this fields acts as output of the downlink decoder, and the input is frm_payload.", + "type": "object" + }, + "decoded_payload_warnings": { + "description": "Warnings generated by the message processor while encoding frm_payload (scheduling downlink) or decoding the frm_payload (reading downlink).", + "type": "array", + "items": { + "type": "string" + } + }, + "f_cnt": { + "type": "integer", + "format": "int64" + }, + "f_port": { + "type": "integer", + "format": "int64" + }, + "frm_payload": { + "description": "The frame payload of the downlink message.\nThe payload is encrypted if the skip_payload_crypto field of the EndDevice\nis true.", + "type": "string", + "format": "byte" + }, + "priority": { + "type": "string", + "default": "LOWEST", + "enum": [ + "LOWEST", + "LOW", + "BELOW_NORMAL", + "NORMAL", + "ABOVE_NORMAL", + "HIGH", + "HIGHEST" + ] + }, + "session_key_id": { + "description": "Join Server issued identifier for the session keys used by this downlink.", + "type": "string", + "format": "byte" + } + } + } + }, + "started_at": { + "description": "Time when the session started. Network Server only.", + "type": "string", + "format": "date-time" + } + } + }, + "skip_payload_crypto": { + "description": "Skip decryption of uplink payloads and encryption of downlink payloads.\nThis field is deprecated, use skip_payload_crypto_override instead.", + "type": "boolean" + }, + "skip_payload_crypto_override": { + "description": "Skip decryption of uplink payloads and encryption of downlink payloads.\nThis field overrides the application-level setting.", + "type": "boolean" + }, + "supports_class_b": { + "description": "Whether the device supports class B.\nCopied on creation from template identified by version_ids, if any or from the home Network Server device profile, if any.", + "type": "boolean" + }, + "supports_class_c": { + "description": "Whether the device supports class C.\nCopied on creation from template identified by version_ids, if any or from the home Network Server device profile, if any.", + "type": "boolean" + }, + "supports_join": { + "description": "The device supports join (it's OTAA).\nCopied on creation from template identified by version_ids, if any or from the home Network Server device profile, if any.", + "type": "boolean" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "used_dev_nonces": { + "description": "Used DevNonces sorted in ascending order.\nThis field is only used for devices using LoRaWAN versions preceding 1.1.\nStored in Join Server.", + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + }, + "version_ids": { + "description": "Identifies an end device model with version information.", + "type": "object", + "properties": { + "band_id": { + "type": "string" + }, + "brand_id": { + "type": "string" + }, + "firmware_version": { + "type": "string" + }, + "hardware_version": { + "type": "string" + }, + "model_id": { + "type": "string" + } + } + } + } + }, + "field_mask": { + "description": "The names of the end device fields that should be updated.\nSee the API reference for which fields can be set on the different services.", + "type": "string" + } + } + }, + "v3NsMACSettingsProfileRegistryCreateBody": { + "type": "object", + "properties": { + "mac_settings_profile": { + "description": "The MAC settings profile to create.", + "type": "object", + "title": "The MAC settings profile to create.", + "properties": { + "ids": { + "description": "Profile identifiers.", + "type": "object", + "title": "Profile identifiers.", + "properties": { + "application_ids": { + "description": "Application IDs.", + "type": "object", + "title": "Application IDs." + }, + "profile_id": { + "description": "Profile ID.", + "type": "string" + } + } + }, + "mac_settings": { + "type": "object", + "properties": { + "adr": { + "description": "Adaptive Data Rate settings.", + "type": "object", + "properties": { + "disabled": { + "description": "Configuration options for cases in which ADR is to be disabled\ncompletely.", + "type": "object" + }, + "dynamic": { + "description": "Configuration options for dynamic ADR.", + "type": "object", + "properties": { + "channel_steering": { + "description": "EXPERIMENTAL: Channel steering settings.", + "type": "object", + "properties": { + "disabled": { + "description": "Configuration options for cases in which ADR is not supposed to steer the end device\nto another set of channels.", + "type": "object" + }, + "lora_narrow": { + "description": "Configuration options for LoRa narrow channels steering.\nThe narrow mode attempts to steer the end device towards\nusing the LoRa modulated, 125kHz bandwidth channels.", + "type": "object" } - }, - "mac_payload": { - "type": "object", - "properties": { - "f_port": { - "type": "integer", - "format": "int64" - }, - "full_f_cnt": { - "type": "integer", - "format": "int64" + } + }, + "margin": { + "description": "The ADR margin (dB) tells the network server how much margin it should add in ADR requests.\nA bigger margin is less efficient, but gives a better chance of successful reception.\nIf unset, the default value from Network Server configuration will be used.", + "type": "number", + "format": "float" + }, + "max_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "max_tx_power_index": { + "description": "Maximum transmission power index.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_tx_power_index": { + "description": "Minimum transmission power index.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "overrides": { + "description": "EXPERIMENTAL: Configuration overrides.", + "type": "object", + "properties": { + "data_rate_0": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_1": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_10": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_11": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_12": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_13": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_14": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_15": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_2": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_3": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_4": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_5": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_6": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_7": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_8": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_9": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } } } } } } + }, + "static": { + "description": "Configuration options for static ADR.", + "type": "object", + "properties": { + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "nb_trans": { + "description": "Number of retransmissions.", + "type": "integer", + "format": "int64" + }, + "tx_power_index": { + "description": "Transmission power index to use.", + "type": "integer", + "format": "int64" + } + } } } }, - "recent_mac_command_identifiers": { - "description": "MAC command identifiers sent by the end device in the last received uplink.\nThe Network Server may choose to store only certain types of MAC\ncommand identifiers in the underlying implementation.", - "type": "array", - "items": { - "type": "string", - "title": "- CID_BEACON_TIMING: Deprecated", - "default": "CID_RFU_0", - "enum": [ - "CID_RFU_0", - "CID_RESET", - "CID_LINK_CHECK", - "CID_LINK_ADR", - "CID_DUTY_CYCLE", - "CID_RX_PARAM_SETUP", - "CID_DEV_STATUS", - "CID_NEW_CHANNEL", - "CID_RX_TIMING_SETUP", - "CID_TX_PARAM_SETUP", - "CID_DL_CHANNEL", - "CID_REKEY", - "CID_ADR_PARAM_SETUP", - "CID_DEVICE_TIME", - "CID_FORCE_REJOIN", - "CID_REJOIN_PARAM_SETUP", - "CID_PING_SLOT_INFO", - "CID_PING_SLOT_CHANNEL", - "CID_BEACON_TIMING", - "CID_BEACON_FREQ", - "CID_DEVICE_MODE", - "CID_RELAY_CONF", - "CID_RELAY_END_DEVICE_CONF", - "CID_RELAY_FILTER_LIST", - "CID_RELAY_UPDATE_UPLINK_LIST", - "CID_RELAY_CTRL_UPLINK_LIST", - "CID_RELAY_CONFIGURE_FWD_LIMIT", - "CID_RELAY_NOTIFY_NEW_END_DEVICE" - ] + "adr_margin": { + "description": "The ADR margin (dB) tells the network server how much margin it should add in ADR requests.\nA bigger margin is less efficient, but gives a better chance of successful reception.\nThis field is deprecated, use adr_settings.dynamic.margin instead.", + "type": "number", + "format": "float" + }, + "beacon_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } } }, - "recent_uplinks": { - "description": "Recent data uplink messages sorted by time.\nThe number of messages stored may depend on configuration.", - "type": "array", - "items": { - "description": "A minimal UplinkMessage definition which is binary compatible with the top level UplinkMessage message.\nUsed for type safe recent uplink storage.", - "type": "object", - "properties": { - "correlation_ids": { - "type": "array", - "items": { + "class_b_c_downlink_interval": { + "description": "The minimum duration passed before a network-initiated(e.g. Class B or C) downlink following an arbitrary downlink.", + "type": "string" + }, + "class_b_timeout": { + "description": "Maximum delay for the device to answer a MAC request or a confirmed downlink frame.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "class_c_timeout": { + "description": "Maximum delay for the device to answer a MAC request or a confirmed downlink frame.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "desired_adr_ack_delay_exponent": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "ADR_ACK_DELAY_1", + "enum": [ + "ADR_ACK_DELAY_1", + "ADR_ACK_DELAY_2", + "ADR_ACK_DELAY_4", + "ADR_ACK_DELAY_8", + "ADR_ACK_DELAY_16", + "ADR_ACK_DELAY_32", + "ADR_ACK_DELAY_64", + "ADR_ACK_DELAY_128", + "ADR_ACK_DELAY_256", + "ADR_ACK_DELAY_512", + "ADR_ACK_DELAY_1024", + "ADR_ACK_DELAY_2048", + "ADR_ACK_DELAY_4096", + "ADR_ACK_DELAY_8192", + "ADR_ACK_DELAY_16384", + "ADR_ACK_DELAY_32768" + ] + } + } + }, + "desired_adr_ack_limit_exponent": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "ADR_ACK_LIMIT_1", + "enum": [ + "ADR_ACK_LIMIT_1", + "ADR_ACK_LIMIT_2", + "ADR_ACK_LIMIT_4", + "ADR_ACK_LIMIT_8", + "ADR_ACK_LIMIT_16", + "ADR_ACK_LIMIT_32", + "ADR_ACK_LIMIT_64", + "ADR_ACK_LIMIT_128", + "ADR_ACK_LIMIT_256", + "ADR_ACK_LIMIT_512", + "ADR_ACK_LIMIT_1024", + "ADR_ACK_LIMIT_2048", + "ADR_ACK_LIMIT_4096", + "ADR_ACK_LIMIT_8192", + "ADR_ACK_LIMIT_16384", + "ADR_ACK_LIMIT_32768" + ] + } + } + }, + "desired_beacon_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "desired_max_duty_cycle": { + "type": "object", + "properties": { + "value": { + "description": " - DUTY_CYCLE_1: 100%.\n - DUTY_CYCLE_2: 50%.\n - DUTY_CYCLE_4: 25%.\n - DUTY_CYCLE_8: 12.5%.\n - DUTY_CYCLE_16: 6.25%.\n - DUTY_CYCLE_32: 3.125%.\n - DUTY_CYCLE_64: 1.5625%.\n - DUTY_CYCLE_128: Roughly 0.781%.\n - DUTY_CYCLE_256: Roughly 0.390%.\n - DUTY_CYCLE_512: Roughly 0.195%.\n - DUTY_CYCLE_1024: Roughly 0.098%.\n - DUTY_CYCLE_2048: Roughly 0.049%.\n - DUTY_CYCLE_4096: Roughly 0.024%.\n - DUTY_CYCLE_8192: Roughly 0.012%.\n - DUTY_CYCLE_16384: Roughly 0.006%.\n - DUTY_CYCLE_32768: Roughly 0.003%.", + "type": "string", + "default": "DUTY_CYCLE_1", + "enum": [ + "DUTY_CYCLE_1", + "DUTY_CYCLE_2", + "DUTY_CYCLE_4", + "DUTY_CYCLE_8", + "DUTY_CYCLE_16", + "DUTY_CYCLE_32", + "DUTY_CYCLE_64", + "DUTY_CYCLE_128", + "DUTY_CYCLE_256", + "DUTY_CYCLE_512", + "DUTY_CYCLE_1024", + "DUTY_CYCLE_2048", + "DUTY_CYCLE_4096", + "DUTY_CYCLE_8192", + "DUTY_CYCLE_16384", + "DUTY_CYCLE_32768" + ] + } + } + }, + "desired_max_eirp": { + "type": "object", + "properties": { + "value": { + "description": " - DEVICE_EIRP_8: 8 dBm.\n - DEVICE_EIRP_10: 10 dBm.\n - DEVICE_EIRP_12: 12 dBm.\n - DEVICE_EIRP_13: 13 dBm.\n - DEVICE_EIRP_14: 14 dBm.\n - DEVICE_EIRP_16: 16 dBm.\n - DEVICE_EIRP_18: 18 dBm.\n - DEVICE_EIRP_20: 20 dBm.\n - DEVICE_EIRP_21: 21 dBm.\n - DEVICE_EIRP_24: 24 dBm.\n - DEVICE_EIRP_26: 26 dBm.\n - DEVICE_EIRP_27: 27 dBm.\n - DEVICE_EIRP_29: 29 dBm.\n - DEVICE_EIRP_30: 30 dBm.\n - DEVICE_EIRP_33: 33 dBm.\n - DEVICE_EIRP_36: 36 dBm.", + "type": "string", + "default": "DEVICE_EIRP_8", + "enum": [ + "DEVICE_EIRP_8", + "DEVICE_EIRP_10", + "DEVICE_EIRP_12", + "DEVICE_EIRP_13", + "DEVICE_EIRP_14", + "DEVICE_EIRP_16", + "DEVICE_EIRP_18", + "DEVICE_EIRP_20", + "DEVICE_EIRP_21", + "DEVICE_EIRP_24", + "DEVICE_EIRP_26", + "DEVICE_EIRP_27", + "DEVICE_EIRP_29", + "DEVICE_EIRP_30", + "DEVICE_EIRP_33", + "DEVICE_EIRP_36" + ] + } + } + }, + "desired_ping_slot_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "desired_ping_slot_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "desired_relay": { + "description": "RelaySettings represent the settings of a relay.\nThis is used internally by the Network Server.", + "type": "object", + "properties": { + "served": { + "type": "object", + "properties": { + "always": { + "type": "object" + }, + "backoff": { + "description": "Number of wake on radio frames to be sent without an acknowledgement before sending the uplink message directly.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "dynamic": { + "type": "object", + "properties": { + "smart_enable_level": { + "type": "string", + "default": "RELAY_SMART_ENABLE_LEVEL_8", + "enum": [ + "RELAY_SMART_ENABLE_LEVEL_8", + "RELAY_SMART_ENABLE_LEVEL_16", + "RELAY_SMART_ENABLE_LEVEL_32", + "RELAY_SMART_ENABLE_LEVEL_64" + ] + } + } + }, + "end_device_controlled": { + "type": "object" + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "serving_device_id": { + "description": "End device identifier of the serving end device.", "type": "string" } - }, - "device_channel_index": { - "type": "integer", - "format": "int64" - }, - "payload": { - "type": "object", - "title": "Message represents a LoRaWAN message", - "properties": { - "join_accept_payload": { - "type": "object", - "properties": { - "cf_list": { - "type": "object", - "properties": { - "ch_masks": { - "description": "ChMasks controlling the channels to be used.\nLength of this field must be equal to the amount of uplink channels\ndefined by the selected frequency plan.", - "type": "array", - "items": { - "type": "boolean" - } - }, - "freq": { - "description": "Frequencies to be broadcasted, in hecto-Hz.\nThese values are broadcasted as 24 bits unsigned integers.\nThis field should not contain default values.", - "type": "array", - "items": { - "type": "integer", - "format": "int64" - } - }, - "type": { - "type": "string", - "default": "FREQUENCIES", - "enum": [ - "FREQUENCIES", - "CHANNEL_MASKS" - ] - } + } + }, + "serving": { + "type": "object", + "properties": { + "cad_periodicity": { + "type": "string", + "title": "- RELAY_CAD_PERIODICITY_20_MILLISECONDS: sic", + "default": "RELAY_CAD_PERIODICITY_1_SECOND", + "enum": [ + "RELAY_CAD_PERIODICITY_1_SECOND", + "RELAY_CAD_PERIODICITY_500_MILLISECONDS", + "RELAY_CAD_PERIODICITY_250_MILLISECONDS", + "RELAY_CAD_PERIODICITY_100_MILLISECONDS", + "RELAY_CAD_PERIODICITY_50_MILLISECONDS", + "RELAY_CAD_PERIODICITY_20_MILLISECONDS" + ] + }, + "default_channel_index": { + "description": "Index of the default wake on radio channel.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "join_requests": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" } - }, - "dev_addr": { - "type": "string", - "format": "string", - "example": "2600ABCD" - }, - "dl_settings": { - "type": "object", - "properties": { - "opt_neg": { - "description": "OptNeg is set if Network Server implements LoRaWAN 1.1 or greater.", - "type": "boolean" - }, - "rx1_dr_offset": { - "type": "string", - "default": "DATA_RATE_OFFSET_0", - "enum": [ - "DATA_RATE_OFFSET_0", - "DATA_RATE_OFFSET_1", - "DATA_RATE_OFFSET_2", - "DATA_RATE_OFFSET_3", - "DATA_RATE_OFFSET_4", - "DATA_RATE_OFFSET_5", - "DATA_RATE_OFFSET_6", - "DATA_RATE_OFFSET_7" - ] - }, - "rx2_dr": { - "type": "string", - "default": "DATA_RATE_0", - "enum": [ - "DATA_RATE_0", - "DATA_RATE_1", - "DATA_RATE_2", - "DATA_RATE_3", - "DATA_RATE_4", - "DATA_RATE_5", - "DATA_RATE_6", - "DATA_RATE_7", - "DATA_RATE_8", - "DATA_RATE_9", - "DATA_RATE_10", - "DATA_RATE_11", - "DATA_RATE_12", - "DATA_RATE_13", - "DATA_RATE_14", - "DATA_RATE_15" - ] - } + } + }, + "notifications": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" } - }, - "encrypted": { - "type": "string", - "format": "byte" - }, - "join_nonce": { - "type": "string", - "format": "string", - "example": "ABCDEF" - }, - "net_id": { - "type": "string", - "format": "string", - "example": "000013" - }, - "rx_delay": { - "description": " - RX_DELAY_0: 1 second.\n - RX_DELAY_1: 1 second.\n - RX_DELAY_2: 2 seconds.\n - RX_DELAY_3: 3 seconds.\n - RX_DELAY_4: 4 seconds.\n - RX_DELAY_5: 5 seconds.\n - RX_DELAY_6: 6 seconds.\n - RX_DELAY_7: 7 seconds.\n - RX_DELAY_8: 8 seconds.\n - RX_DELAY_9: 9 seconds.\n - RX_DELAY_10: 10 seconds.\n - RX_DELAY_11: 11 seconds.\n - RX_DELAY_12: 12 seconds.\n - RX_DELAY_13: 13 seconds.\n - RX_DELAY_14: 14 seconds.\n - RX_DELAY_15: 15 seconds.", - "type": "string", - "default": "RX_DELAY_0", - "enum": [ - "RX_DELAY_0", - "RX_DELAY_1", - "RX_DELAY_2", - "RX_DELAY_3", - "RX_DELAY_4", - "RX_DELAY_5", - "RX_DELAY_6", - "RX_DELAY_7", - "RX_DELAY_8", - "RX_DELAY_9", - "RX_DELAY_10", - "RX_DELAY_11", - "RX_DELAY_12", - "RX_DELAY_13", - "RX_DELAY_14", - "RX_DELAY_15" - ] } - } - }, - "join_request_payload": { - "type": "object", - "properties": { - "dev_eui": { - "type": "string", - "format": "string", - "example": "70B3D57ED000ABCD" - }, - "dev_nonce": { - "type": "string", - "format": "string", - "example": "ABCD" - }, - "join_eui": { - "type": "string", - "format": "string", - "example": "70B3D57ED000ABCD" + }, + "overall": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } } - } - }, - "m_hdr": { - "type": "object", - "properties": { - "m_type": { - "type": "string", - "default": "JOIN_REQUEST", - "enum": [ - "JOIN_REQUEST", - "JOIN_ACCEPT", - "UNCONFIRMED_UP", - "UNCONFIRMED_DOWN", - "CONFIRMED_UP", - "CONFIRMED_DOWN", - "REJOIN_REQUEST", - "PROPRIETARY" - ] - }, - "major": { - "type": "string", - "default": "LORAWAN_R1", - "enum": [ - "LORAWAN_R1" - ] + }, + "reset_behavior": { + "type": "string", + "default": "RELAY_RESET_LIMIT_COUNTER_ZERO", + "enum": [ + "RELAY_RESET_LIMIT_COUNTER_ZERO", + "RELAY_RESET_LIMIT_COUNTER_RELOAD_RATE", + "RELAY_RESET_LIMIT_COUNTER_MAX_VALUE", + "RELAY_RESET_LIMIT_COUNTER_NO_RESET" + ] + }, + "uplink_messages": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } } } - }, - "mac_payload": { + } + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "uplink_forwarding_rules": { + "description": "Configured uplink forwarding rules.", + "type": "array", + "items": { "type": "object", "properties": { - "decoded_payload": { - "type": "object" + "device_id": { + "description": "End device identifier of the served end device.", + "type": "string" }, - "f_hdr": { + "last_w_f_cnt": { + "description": "Last wake on radio frame counter used by the served end device.", + "type": "integer", + "format": "int64" + }, + "limits": { "type": "object", "properties": { - "dev_addr": { + "bucket_size": { "type": "string", - "format": "string", - "example": "2600ABCD" + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] }, - "f_cnt": { + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", "type": "integer", "format": "int64" - }, - "f_ctrl": { - "type": "object", - "properties": { - "ack": { - "type": "boolean" - }, - "adr": { - "type": "boolean" - }, - "adr_ack_req": { - "description": "Only on uplink.", - "type": "boolean" - }, - "class_b": { - "description": "Only on uplink.", - "type": "boolean" - }, - "f_pending": { - "description": "Only on downlink.", - "type": "boolean" - } - } - }, - "f_opts": { - "type": "string", - "format": "byte" } } }, - "f_port": { - "type": "integer", - "format": "int64" - }, - "frm_payload": { + "session_key_id": { + "description": "Session key ID of the session keys used to derive the root relay session key.", "type": "string", "format": "byte" - }, - "full_f_cnt": { - "description": "Full 32-bit FCnt value. Used internally by Network Server.", - "type": "integer", - "format": "int64" - } - } - }, - "mic": { - "type": "string", - "format": "byte" - }, - "rejoin_request_payload": { - "type": "object", - "properties": { - "dev_eui": { - "type": "string", - "format": "string", - "example": "70B3D57ED000ABCD" - }, - "join_eui": { - "type": "string", - "format": "string", - "example": "70B3D57ED000ABCD" - }, - "net_id": { - "type": "string", - "format": "string", - "example": "000013" - }, - "rejoin_cnt": { - "description": "Contains RJCount0 or RJCount1 depending on rejoin_type.", - "type": "integer", - "format": "int64" - }, - "rejoin_type": { - "description": " - CONTEXT: Resets DevAddr, Session Keys, Frame Counters, Radio Parameters.\n - SESSION: Equivalent to the initial JoinRequest.\n - KEYS: Resets DevAddr, Session Keys, Frame Counters, while keeping the Radio Parameters.", - "type": "string", - "default": "CONTEXT", - "enum": [ - "CONTEXT", - "SESSION", - "KEYS" - ] } } } } - }, - "received_at": { - "type": "string", - "format": "date-time" - }, - "rx_metadata": { - "type": "array", - "items": { + } + } + } + }, + "desired_rx1_data_rate_offset": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_OFFSET_0", + "enum": [ + "DATA_RATE_OFFSET_0", + "DATA_RATE_OFFSET_1", + "DATA_RATE_OFFSET_2", + "DATA_RATE_OFFSET_3", + "DATA_RATE_OFFSET_4", + "DATA_RATE_OFFSET_5", + "DATA_RATE_OFFSET_6", + "DATA_RATE_OFFSET_7" + ] + } + } + }, + "desired_rx1_delay": { + "type": "object", + "properties": { + "value": { + "description": " - RX_DELAY_0: 1 second.\n - RX_DELAY_1: 1 second.\n - RX_DELAY_2: 2 seconds.\n - RX_DELAY_3: 3 seconds.\n - RX_DELAY_4: 4 seconds.\n - RX_DELAY_5: 5 seconds.\n - RX_DELAY_6: 6 seconds.\n - RX_DELAY_7: 7 seconds.\n - RX_DELAY_8: 8 seconds.\n - RX_DELAY_9: 9 seconds.\n - RX_DELAY_10: 10 seconds.\n - RX_DELAY_11: 11 seconds.\n - RX_DELAY_12: 12 seconds.\n - RX_DELAY_13: 13 seconds.\n - RX_DELAY_14: 14 seconds.\n - RX_DELAY_15: 15 seconds.", + "type": "string", + "default": "RX_DELAY_0", + "enum": [ + "RX_DELAY_0", + "RX_DELAY_1", + "RX_DELAY_2", + "RX_DELAY_3", + "RX_DELAY_4", + "RX_DELAY_5", + "RX_DELAY_6", + "RX_DELAY_7", + "RX_DELAY_8", + "RX_DELAY_9", + "RX_DELAY_10", + "RX_DELAY_11", + "RX_DELAY_12", + "RX_DELAY_13", + "RX_DELAY_14", + "RX_DELAY_15" + ] + } + } + }, + "desired_rx2_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "desired_rx2_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "downlink_dwell_time": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "factory_preset_frequencies": { + "description": "List of factory-preset frequencies.\nIf unset, the default value from Network Server configuration or regional parameters specification will be used.", + "type": "array", + "items": { + "type": "string", + "format": "uint64" + } + }, + "max_duty_cycle": { + "type": "object", + "properties": { + "value": { + "description": " - DUTY_CYCLE_1: 100%.\n - DUTY_CYCLE_2: 50%.\n - DUTY_CYCLE_4: 25%.\n - DUTY_CYCLE_8: 12.5%.\n - DUTY_CYCLE_16: 6.25%.\n - DUTY_CYCLE_32: 3.125%.\n - DUTY_CYCLE_64: 1.5625%.\n - DUTY_CYCLE_128: Roughly 0.781%.\n - DUTY_CYCLE_256: Roughly 0.390%.\n - DUTY_CYCLE_512: Roughly 0.195%.\n - DUTY_CYCLE_1024: Roughly 0.098%.\n - DUTY_CYCLE_2048: Roughly 0.049%.\n - DUTY_CYCLE_4096: Roughly 0.024%.\n - DUTY_CYCLE_8192: Roughly 0.012%.\n - DUTY_CYCLE_16384: Roughly 0.006%.\n - DUTY_CYCLE_32768: Roughly 0.003%.", + "type": "string", + "default": "DUTY_CYCLE_1", + "enum": [ + "DUTY_CYCLE_1", + "DUTY_CYCLE_2", + "DUTY_CYCLE_4", + "DUTY_CYCLE_8", + "DUTY_CYCLE_16", + "DUTY_CYCLE_32", + "DUTY_CYCLE_64", + "DUTY_CYCLE_128", + "DUTY_CYCLE_256", + "DUTY_CYCLE_512", + "DUTY_CYCLE_1024", + "DUTY_CYCLE_2048", + "DUTY_CYCLE_4096", + "DUTY_CYCLE_8192", + "DUTY_CYCLE_16384", + "DUTY_CYCLE_32768" + ] + } + } + }, + "ping_slot_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "ping_slot_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "ping_slot_periodicity": { + "type": "object", + "properties": { + "value": { + "description": " - PING_EVERY_1S: Every second.\n - PING_EVERY_2S: Every 2 seconds.\n - PING_EVERY_4S: Every 4 seconds.\n - PING_EVERY_8S: Every 8 seconds.\n - PING_EVERY_16S: Every 16 seconds.\n - PING_EVERY_32S: Every 32 seconds.\n - PING_EVERY_64S: Every 64 seconds.\n - PING_EVERY_128S: Every 128 seconds.", + "type": "string", + "default": "PING_EVERY_1S", + "enum": [ + "PING_EVERY_1S", + "PING_EVERY_2S", + "PING_EVERY_4S", + "PING_EVERY_8S", + "PING_EVERY_16S", + "PING_EVERY_32S", + "PING_EVERY_64S", + "PING_EVERY_128S" + ] + } + } + }, + "relay": { + "description": "RelaySettings represent the settings of a relay.\nThis is used internally by the Network Server.", + "type": "object", + "properties": { + "served": { + "type": "object", + "properties": { + "always": { + "type": "object" + }, + "backoff": { + "description": "Number of wake on radio frames to be sent without an acknowledgement before sending the uplink message directly.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "dynamic": { "type": "object", "properties": { - "channel_rssi": { - "type": "number", - "format": "float" + "smart_enable_level": { + "type": "string", + "default": "RELAY_SMART_ENABLE_LEVEL_8", + "enum": [ + "RELAY_SMART_ENABLE_LEVEL_8", + "RELAY_SMART_ENABLE_LEVEL_16", + "RELAY_SMART_ENABLE_LEVEL_32", + "RELAY_SMART_ENABLE_LEVEL_64" + ] + } + } + }, + "end_device_controlled": { + "type": "object" + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] }, - "downlink_path_constraint": { - "description": " - DOWNLINK_PATH_CONSTRAINT_NONE: Indicates that the gateway can be selected for downlink without constraints by the Network Server.\n - DOWNLINK_PATH_CONSTRAINT_PREFER_OTHER: Indicates that the gateway can be selected for downlink only if no other or better gateway can be selected.\n - DOWNLINK_PATH_CONSTRAINT_NEVER: Indicates that this gateway will never be selected for downlink, even if that results in no available downlink path.", + "data_rate_index": { "type": "string", - "default": "DOWNLINK_PATH_CONSTRAINT_NONE", + "default": "DATA_RATE_0", "enum": [ - "DOWNLINK_PATH_CONSTRAINT_NONE", - "DOWNLINK_PATH_CONSTRAINT_PREFER_OTHER", - "DOWNLINK_PATH_CONSTRAINT_NEVER" + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" ] }, - "gateway_ids": { + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "serving_device_id": { + "description": "End device identifier of the serving end device.", + "type": "string" + } + } + }, + "serving": { + "type": "object", + "properties": { + "cad_periodicity": { + "type": "string", + "title": "- RELAY_CAD_PERIODICITY_20_MILLISECONDS: sic", + "default": "RELAY_CAD_PERIODICITY_1_SECOND", + "enum": [ + "RELAY_CAD_PERIODICITY_1_SECOND", + "RELAY_CAD_PERIODICITY_500_MILLISECONDS", + "RELAY_CAD_PERIODICITY_250_MILLISECONDS", + "RELAY_CAD_PERIODICITY_100_MILLISECONDS", + "RELAY_CAD_PERIODICITY_50_MILLISECONDS", + "RELAY_CAD_PERIODICITY_20_MILLISECONDS" + ] + }, + "default_channel_index": { + "description": "Index of the default wake on radio channel.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "join_requests": { "type": "object", "properties": { - "eui": { - "description": "Secondary identifier, which can only be used in specific requests.", + "bucket_size": { "type": "string", - "format": "string", - "example": "70B3D57ED000ABCD" + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] }, - "gateway_id": { - "type": "string" + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" } } }, - "packet_broker": { - "type": "object" + "notifications": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } }, - "relay": { - "type": "object" + "overall": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } }, - "snr": { - "type": "number", - "format": "float" + "reset_behavior": { + "type": "string", + "default": "RELAY_RESET_LIMIT_COUNTER_ZERO", + "enum": [ + "RELAY_RESET_LIMIT_COUNTER_ZERO", + "RELAY_RESET_LIMIT_COUNTER_RELOAD_RATE", + "RELAY_RESET_LIMIT_COUNTER_MAX_VALUE", + "RELAY_RESET_LIMIT_COUNTER_NO_RESET" + ] }, - "uplink_token": { + "uplink_messages": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + } + } + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { "type": "string", - "format": "byte" + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" } } - } - }, - "settings": { - "type": "object", - "properties": { - "data_rate": { + }, + "uplink_forwarding_rules": { + "description": "Configured uplink forwarding rules.", + "type": "array", + "items": { "type": "object", "properties": { - "fsk": { - "type": "object", - "properties": { - "bit_rate": { - "description": "Bit rate (bps).", - "type": "integer", - "format": "int64" - } - } + "device_id": { + "description": "End device identifier of the served end device.", + "type": "string" }, - "lora": { - "type": "object", - "properties": { - "bandwidth": { - "description": "Bandwidth (Hz).", - "type": "integer", - "format": "int64" - }, - "coding_rate": { - "type": "string" - }, - "spreading_factor": { - "type": "integer", - "format": "int64" - } - } + "last_w_f_cnt": { + "description": "Last wake on radio frame counter used by the served end device.", + "type": "integer", + "format": "int64" }, - "lrfhss": { + "limits": { "type": "object", "properties": { - "coding_rate": { - "type": "string" - }, - "modulation_type": { - "type": "integer", - "format": "int64" + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] }, - "operating_channel_width": { - "description": "Operating Channel Width (Hz).", + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", "type": "integer", "format": "int64" } } + }, + "session_key_id": { + "description": "Session key ID of the session keys used to derive the root relay session key.", + "type": "string", + "format": "byte" } } } @@ -655752,52 +678017,209 @@ } } }, - "rejected_adr_data_rate_indexes": { - "description": "ADR Data rate index values rejected by the device.\nReset each time `current_parameters.channels` change.\nElements are sorted in ascending order.", - "type": "array", - "items": { - "type": "string", - "default": "DATA_RATE_0", - "enum": [ - "DATA_RATE_0", - "DATA_RATE_1", - "DATA_RATE_2", - "DATA_RATE_3", - "DATA_RATE_4", - "DATA_RATE_5", - "DATA_RATE_6", - "DATA_RATE_7", - "DATA_RATE_8", - "DATA_RATE_9", - "DATA_RATE_10", - "DATA_RATE_11", - "DATA_RATE_12", - "DATA_RATE_13", - "DATA_RATE_14", - "DATA_RATE_15" - ] + "resets_f_cnt": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } } }, - "rejected_adr_tx_power_indexes": { - "description": "ADR TX output power index values rejected by the device.\nElements are sorted in ascending order.", - "type": "array", - "items": { - "type": "integer", - "format": "int64" + "rx1_data_rate_offset": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_OFFSET_0", + "enum": [ + "DATA_RATE_OFFSET_0", + "DATA_RATE_OFFSET_1", + "DATA_RATE_OFFSET_2", + "DATA_RATE_OFFSET_3", + "DATA_RATE_OFFSET_4", + "DATA_RATE_OFFSET_5", + "DATA_RATE_OFFSET_6", + "DATA_RATE_OFFSET_7" + ] + } + } + }, + "rx1_delay": { + "type": "object", + "properties": { + "value": { + "description": " - RX_DELAY_0: 1 second.\n - RX_DELAY_1: 1 second.\n - RX_DELAY_2: 2 seconds.\n - RX_DELAY_3: 3 seconds.\n - RX_DELAY_4: 4 seconds.\n - RX_DELAY_5: 5 seconds.\n - RX_DELAY_6: 6 seconds.\n - RX_DELAY_7: 7 seconds.\n - RX_DELAY_8: 8 seconds.\n - RX_DELAY_9: 9 seconds.\n - RX_DELAY_10: 10 seconds.\n - RX_DELAY_11: 11 seconds.\n - RX_DELAY_12: 12 seconds.\n - RX_DELAY_13: 13 seconds.\n - RX_DELAY_14: 14 seconds.\n - RX_DELAY_15: 15 seconds.", + "type": "string", + "default": "RX_DELAY_0", + "enum": [ + "RX_DELAY_0", + "RX_DELAY_1", + "RX_DELAY_2", + "RX_DELAY_3", + "RX_DELAY_4", + "RX_DELAY_5", + "RX_DELAY_6", + "RX_DELAY_7", + "RX_DELAY_8", + "RX_DELAY_9", + "RX_DELAY_10", + "RX_DELAY_11", + "RX_DELAY_12", + "RX_DELAY_13", + "RX_DELAY_14", + "RX_DELAY_15" + ] + } + } + }, + "rx2_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "rx2_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "schedule_downlinks": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "status_count_periodicity": { + "description": "Number of uplink messages after which a DevStatusReq MACCommand shall be sent.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "status_time_periodicity": { + "description": "The interval after which a DevStatusReq MACCommand shall be sent.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "supports_32_bit_f_cnt": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "uplink_dwell_time": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "use_adr": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + } + } + } + } + } + } + }, + "v3NsMACSettingsProfileRegistryUpdateBody": { + "type": "object", + "properties": { + "field_mask": { + "description": "The names of the fields that should be updated.", + "type": "string" + }, + "mac_settings_profile": { + "type": "object", + "properties": { + "ids": { + "type": "object", + "properties": { + "application_ids": { + "type": "object", + "properties": { + "application_id": { + "type": "string" + } } }, - "rejected_data_rate_ranges": { - "description": "Data rate ranges rejected by the device per frequency.", + "profile_id": { + "description": "Profile ID.", + "type": "string" + } + } + }, + "mac_settings": { + "type": "object", + "properties": { + "adr": { + "description": "Adaptive Data Rate settings.", "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "ranges": { - "type": "array", - "items": { + "properties": { + "disabled": { + "description": "Configuration options for cases in which ADR is to be disabled\ncompletely.", + "type": "object" + }, + "dynamic": { + "description": "Configuration options for dynamic ADR.", + "type": "object", + "properties": { + "channel_steering": { + "description": "EXPERIMENTAL: Channel steering settings.", "type": "object", "properties": { - "max_data_rate_index": { + "disabled": { + "description": "Configuration options for cases in which ADR is not supposed to steer the end device\nto another set of channels.", + "type": "object" + }, + "lora_narrow": { + "description": "Configuration options for LoRa narrow channels steering.\nThe narrow mode attempts to steer the end device towards\nusing the LoRa modulated, 125kHz bandwidth channels.", + "type": "object" + } + } + }, + "margin": { + "description": "The ADR margin (dB) tells the network server how much margin it should add in ADR requests.\nA bigger margin is less efficient, but gives a better chance of successful reception.\nIf unset, the default value from Network Server configuration will be used.", + "type": "number", + "format": "float" + }, + "max_data_rate_index": { + "type": "object", + "properties": { + "value": { "type": "string", "default": "DATA_RATE_0", "enum": [ @@ -655818,8 +678240,23 @@ "DATA_RATE_14", "DATA_RATE_15" ] - }, - "min_data_rate_index": { + } + } + }, + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "max_tx_power_index": { + "description": "Maximum transmission power index.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_data_rate_index": { + "type": "object", + "properties": { + "value": { "type": "string", "default": "DATA_RATE_0", "enum": [ @@ -655842,780 +678279,1426 @@ ] } } + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_tx_power_index": { + "description": "Minimum transmission power index.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "overrides": { + "description": "EXPERIMENTAL: Configuration overrides.", + "type": "object", + "properties": { + "data_rate_0": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_1": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_10": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_11": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_12": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_13": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_14": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_15": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_2": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_3": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_4": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_5": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_6": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_7": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_8": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_9": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + } + } + } + } + }, + "static": { + "description": "Configuration options for static ADR.", + "type": "object", + "properties": { + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "nb_trans": { + "description": "Number of retransmissions.", + "type": "integer", + "format": "int64" + }, + "tx_power_index": { + "description": "Transmission power index to use.", + "type": "integer", + "format": "int64" } } } } }, - "rejected_frequencies": { - "description": "Frequencies rejected by the device.", - "type": "array", - "items": { - "type": "string", - "format": "uint64" + "adr_margin": { + "description": "The ADR margin (dB) tells the network server how much margin it should add in ADR requests.\nA bigger margin is less efficient, but gives a better chance of successful reception.\nThis field is deprecated, use adr_settings.dynamic.margin instead.", + "type": "number", + "format": "float" + }, + "beacon_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } } }, - "rx_windows_available": { - "description": "Whether or not Rx windows are expected to be open.\nSet to true every time an uplink is received.\nSet to false every time a successful downlink scheduling attempt is made.", - "type": "boolean" - } - } - }, - "pending_session": { - "type": "object", - "properties": { - "dev_addr": { - "description": "Device Address, issued by the Network Server or chosen by device manufacturer in case of testing range (beginning with 00-03).\nKnown by Network Server, Application Server and Join Server. Owned by Network Server.", - "type": "string", - "format": "string", - "example": "2600ABCD" + "class_b_c_downlink_interval": { + "description": "The minimum duration passed before a network-initiated(e.g. Class B or C) downlink following an arbitrary downlink.", + "type": "string" }, - "keys": { - "description": "Session keys for a LoRaWAN session.\nOnly the components for which the keys were meant, will have the key-encryption-key (KEK) to decrypt the individual keys.", + "class_b_timeout": { + "description": "Maximum delay for the device to answer a MAC request or a confirmed downlink frame.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "class_c_timeout": { + "description": "Maximum delay for the device to answer a MAC request or a confirmed downlink frame.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "desired_adr_ack_delay_exponent": { "type": "object", "properties": { - "app_s_key": { + "value": { + "type": "string", + "default": "ADR_ACK_DELAY_1", + "enum": [ + "ADR_ACK_DELAY_1", + "ADR_ACK_DELAY_2", + "ADR_ACK_DELAY_4", + "ADR_ACK_DELAY_8", + "ADR_ACK_DELAY_16", + "ADR_ACK_DELAY_32", + "ADR_ACK_DELAY_64", + "ADR_ACK_DELAY_128", + "ADR_ACK_DELAY_256", + "ADR_ACK_DELAY_512", + "ADR_ACK_DELAY_1024", + "ADR_ACK_DELAY_2048", + "ADR_ACK_DELAY_4096", + "ADR_ACK_DELAY_8192", + "ADR_ACK_DELAY_16384", + "ADR_ACK_DELAY_32768" + ] + } + } + }, + "desired_adr_ack_limit_exponent": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "ADR_ACK_LIMIT_1", + "enum": [ + "ADR_ACK_LIMIT_1", + "ADR_ACK_LIMIT_2", + "ADR_ACK_LIMIT_4", + "ADR_ACK_LIMIT_8", + "ADR_ACK_LIMIT_16", + "ADR_ACK_LIMIT_32", + "ADR_ACK_LIMIT_64", + "ADR_ACK_LIMIT_128", + "ADR_ACK_LIMIT_256", + "ADR_ACK_LIMIT_512", + "ADR_ACK_LIMIT_1024", + "ADR_ACK_LIMIT_2048", + "ADR_ACK_LIMIT_4096", + "ADR_ACK_LIMIT_8192", + "ADR_ACK_LIMIT_16384", + "ADR_ACK_LIMIT_32768" + ] + } + } + }, + "desired_beacon_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "desired_max_duty_cycle": { + "type": "object", + "properties": { + "value": { + "description": " - DUTY_CYCLE_1: 100%.\n - DUTY_CYCLE_2: 50%.\n - DUTY_CYCLE_4: 25%.\n - DUTY_CYCLE_8: 12.5%.\n - DUTY_CYCLE_16: 6.25%.\n - DUTY_CYCLE_32: 3.125%.\n - DUTY_CYCLE_64: 1.5625%.\n - DUTY_CYCLE_128: Roughly 0.781%.\n - DUTY_CYCLE_256: Roughly 0.390%.\n - DUTY_CYCLE_512: Roughly 0.195%.\n - DUTY_CYCLE_1024: Roughly 0.098%.\n - DUTY_CYCLE_2048: Roughly 0.049%.\n - DUTY_CYCLE_4096: Roughly 0.024%.\n - DUTY_CYCLE_8192: Roughly 0.012%.\n - DUTY_CYCLE_16384: Roughly 0.006%.\n - DUTY_CYCLE_32768: Roughly 0.003%.", + "type": "string", + "default": "DUTY_CYCLE_1", + "enum": [ + "DUTY_CYCLE_1", + "DUTY_CYCLE_2", + "DUTY_CYCLE_4", + "DUTY_CYCLE_8", + "DUTY_CYCLE_16", + "DUTY_CYCLE_32", + "DUTY_CYCLE_64", + "DUTY_CYCLE_128", + "DUTY_CYCLE_256", + "DUTY_CYCLE_512", + "DUTY_CYCLE_1024", + "DUTY_CYCLE_2048", + "DUTY_CYCLE_4096", + "DUTY_CYCLE_8192", + "DUTY_CYCLE_16384", + "DUTY_CYCLE_32768" + ] + } + } + }, + "desired_max_eirp": { + "type": "object", + "properties": { + "value": { + "description": " - DEVICE_EIRP_8: 8 dBm.\n - DEVICE_EIRP_10: 10 dBm.\n - DEVICE_EIRP_12: 12 dBm.\n - DEVICE_EIRP_13: 13 dBm.\n - DEVICE_EIRP_14: 14 dBm.\n - DEVICE_EIRP_16: 16 dBm.\n - DEVICE_EIRP_18: 18 dBm.\n - DEVICE_EIRP_20: 20 dBm.\n - DEVICE_EIRP_21: 21 dBm.\n - DEVICE_EIRP_24: 24 dBm.\n - DEVICE_EIRP_26: 26 dBm.\n - DEVICE_EIRP_27: 27 dBm.\n - DEVICE_EIRP_29: 29 dBm.\n - DEVICE_EIRP_30: 30 dBm.\n - DEVICE_EIRP_33: 33 dBm.\n - DEVICE_EIRP_36: 36 dBm.", + "type": "string", + "default": "DEVICE_EIRP_8", + "enum": [ + "DEVICE_EIRP_8", + "DEVICE_EIRP_10", + "DEVICE_EIRP_12", + "DEVICE_EIRP_13", + "DEVICE_EIRP_14", + "DEVICE_EIRP_16", + "DEVICE_EIRP_18", + "DEVICE_EIRP_20", + "DEVICE_EIRP_21", + "DEVICE_EIRP_24", + "DEVICE_EIRP_26", + "DEVICE_EIRP_27", + "DEVICE_EIRP_29", + "DEVICE_EIRP_30", + "DEVICE_EIRP_33", + "DEVICE_EIRP_36" + ] + } + } + }, + "desired_ping_slot_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "desired_ping_slot_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "desired_relay": { + "description": "RelaySettings represent the settings of a relay.\nThis is used internally by the Network Server.", + "type": "object", + "properties": { + "served": { "type": "object", "properties": { - "encrypted_key": { - "type": "string", - "format": "byte" + "always": { + "type": "object" }, - "kek_label": { - "description": "The label of the RFC 3394 key-encryption-key (KEK) that was used to encrypt the key.", - "type": "string" + "backoff": { + "description": "Number of wake on radio frames to be sent without an acknowledgement before sending the uplink message directly.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" }, - "key": { - "description": "The unencrypted AES key.", - "type": "string", - "format": "string", - "example": "0123456789ABCDEF0123456789ABCDEF" - } - } - }, - "f_nwk_s_int_key": { - "type": "object", - "properties": { - "encrypted_key": { - "type": "string", - "format": "byte" + "dynamic": { + "type": "object", + "properties": { + "smart_enable_level": { + "type": "string", + "default": "RELAY_SMART_ENABLE_LEVEL_8", + "enum": [ + "RELAY_SMART_ENABLE_LEVEL_8", + "RELAY_SMART_ENABLE_LEVEL_16", + "RELAY_SMART_ENABLE_LEVEL_32", + "RELAY_SMART_ENABLE_LEVEL_64" + ] + } + } }, - "kek_label": { - "description": "The label of the RFC 3394 key-encryption-key (KEK) that was used to encrypt the key.", - "type": "string" + "end_device_controlled": { + "type": "object" }, - "key": { - "description": "The unencrypted AES key.", - "type": "string", - "format": "string", - "example": "0123456789ABCDEF0123456789ABCDEF" - } - } - }, - "nwk_s_enc_key": { - "type": "object", - "properties": { - "encrypted_key": { - "type": "string", - "format": "byte" + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } }, - "kek_label": { - "description": "The label of the RFC 3394 key-encryption-key (KEK) that was used to encrypt the key.", + "serving_device_id": { + "description": "End device identifier of the serving end device.", "type": "string" - }, - "key": { - "description": "The unencrypted AES key.", - "type": "string", - "format": "string", - "example": "0123456789ABCDEF0123456789ABCDEF" } } }, - "s_nwk_s_int_key": { + "serving": { "type": "object", "properties": { - "encrypted_key": { + "cad_periodicity": { "type": "string", - "format": "byte" + "title": "- RELAY_CAD_PERIODICITY_20_MILLISECONDS: sic", + "default": "RELAY_CAD_PERIODICITY_1_SECOND", + "enum": [ + "RELAY_CAD_PERIODICITY_1_SECOND", + "RELAY_CAD_PERIODICITY_500_MILLISECONDS", + "RELAY_CAD_PERIODICITY_250_MILLISECONDS", + "RELAY_CAD_PERIODICITY_100_MILLISECONDS", + "RELAY_CAD_PERIODICITY_50_MILLISECONDS", + "RELAY_CAD_PERIODICITY_20_MILLISECONDS" + ] }, - "kek_label": { - "description": "The label of the RFC 3394 key-encryption-key (KEK) that was used to encrypt the key.", - "type": "string" + "default_channel_index": { + "description": "Index of the default wake on radio channel.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" }, - "key": { - "description": "The unencrypted AES key.", - "type": "string", - "format": "string", - "example": "0123456789ABCDEF0123456789ABCDEF" - } - } - }, - "session_key_id": { - "description": "Join Server issued identifier for the session keys.\nThis ID can be used to request the keys from the Join Server in case the are lost.", - "type": "string", - "format": "byte" - } - } - }, - "last_a_f_cnt_down": { - "description": "Last application downlink frame counter value used. Application Server only.", - "type": "integer", - "format": "int64" - }, - "last_conf_f_cnt_down": { - "description": "Frame counter of the last confirmed downlink message sent. Network Server only.", - "type": "integer", - "format": "int64" - }, - "last_f_cnt_up": { - "description": "Last uplink frame counter value used. Network Server only. Application Server assumes the Network Server checked it.", - "type": "integer", - "format": "int64" - }, - "last_n_f_cnt_down": { - "description": "Last network downlink frame counter value used. Network Server only.", - "type": "integer", - "format": "int64" - }, - "queued_application_downlinks": { - "description": "Queued Application downlink messages. Stored in Application Server and Network Server.", - "type": "array", - "items": { - "type": "object", - "properties": { - "class_b_c": { - "type": "object", - "properties": { - "absolute_time": { - "description": "Absolute time when the downlink message should be transmitted.\nThis requires the gateway to have GPS time synchronization.\nIf the time is in the past or if there is a scheduling conflict, the downlink message fails.\nIf null, the time is selected based on slot availability. This is recommended in class B mode.", - "type": "string", - "format": "date-time" - }, - "gateways": { - "description": "Possible gateway identifiers, antenna index, and group index to use for this downlink message.\nThe Network Server selects one of these gateways for downlink, based on connectivity, signal quality, channel utilization and an available slot.\nIf none of the gateways can be selected, the downlink message fails.\nIf empty, a gateway and antenna is selected automatically from the gateways seen in recent uplinks.\nIf group index is set, gateways will be grouped by the index for the Network Server to select one gateway per group.", - "type": "array", - "items": { + "limits": { + "type": "object", + "properties": { + "join_requests": { "type": "object", "properties": { - "antenna_index": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", "type": "integer", "format": "int64" + } + } + }, + "notifications": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] }, - "gateway_ids": { - "type": "object", - "properties": { - "eui": { - "description": "Secondary identifier, which can only be used in specific requests.", - "type": "string", - "format": "string", - "example": "70B3D57ED000ABCD" - }, - "gateway_id": { - "type": "string" - } - } + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "overall": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] }, - "group_index": { + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "reset_behavior": { + "type": "string", + "default": "RELAY_RESET_LIMIT_COUNTER_ZERO", + "enum": [ + "RELAY_RESET_LIMIT_COUNTER_ZERO", + "RELAY_RESET_LIMIT_COUNTER_RELOAD_RATE", + "RELAY_RESET_LIMIT_COUNTER_MAX_VALUE", + "RELAY_RESET_LIMIT_COUNTER_NO_RESET" + ] + }, + "uplink_messages": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", "type": "integer", "format": "int64" } } } } - } - }, - "confirmed": { - "type": "boolean" - }, - "confirmed_retry": { - "type": "object", - "properties": { - "attempt": { - "description": "The number of attempted confirmed downlink acknowledgements.", - "type": "integer", - "format": "int64" - }, - "max_attempts": { - "description": "The maximum number of confirmed downlink acknowledgement attempts.\nIf null, the Application Server configuration is used instead.", - "type": "integer", - "format": "int64" + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "uplink_forwarding_rules": { + "description": "Configured uplink forwarding rules.", + "type": "array", + "items": { + "type": "object", + "properties": { + "device_id": { + "description": "End device identifier of the served end device.", + "type": "string" + }, + "last_w_f_cnt": { + "description": "Last wake on radio frame counter used by the served end device.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "session_key_id": { + "description": "Session key ID of the session keys used to derive the root relay session key.", + "type": "string", + "format": "byte" + } + } } } - }, - "correlation_ids": { - "type": "array", - "items": { - "type": "string" - } - }, - "decoded_payload": { - "description": "The decoded frame payload of the downlink message.\nWhen scheduling downlink with a message processor configured for the end device (see formatters) or application (see default_formatters),\nthis fields acts as input for the downlink encoder, and the output is set to frm_payload.\nWhen reading downlink (listing the queue, downlink message events, etc), this fields acts as output of the downlink decoder, and the input is frm_payload.", - "type": "object" - }, - "decoded_payload_warnings": { - "description": "Warnings generated by the message processor while encoding frm_payload (scheduling downlink) or decoding the frm_payload (reading downlink).", - "type": "array", - "items": { - "type": "string" - } - }, - "f_cnt": { - "type": "integer", - "format": "int64" - }, - "f_port": { - "type": "integer", - "format": "int64" - }, - "frm_payload": { - "description": "The frame payload of the downlink message.\nThe payload is encrypted if the skip_payload_crypto field of the EndDevice\nis true.", - "type": "string", - "format": "byte" - }, - "priority": { - "type": "string", - "default": "LOWEST", - "enum": [ - "LOWEST", - "LOW", - "BELOW_NORMAL", - "NORMAL", - "ABOVE_NORMAL", - "HIGH", - "HIGHEST" - ] - }, - "session_key_id": { - "description": "Join Server issued identifier for the session keys used by this downlink.", - "type": "string", - "format": "byte" } } } }, - "started_at": { - "description": "Time when the session started. Network Server only.", - "type": "string", - "format": "date-time" - } - } - }, - "picture": { - "type": "object", - "properties": { - "embedded": { + "desired_rx1_data_rate_offset": { "type": "object", "properties": { - "data": { - "description": "Picture data. A data URI can be constructed as follows:\n`data:\u003cmime_type\u003e;base64,\u003cdata\u003e`.", + "value": { "type": "string", - "format": "byte" - }, - "mime_type": { - "description": "MIME type of the picture.", - "type": "string" + "default": "DATA_RATE_OFFSET_0", + "enum": [ + "DATA_RATE_OFFSET_0", + "DATA_RATE_OFFSET_1", + "DATA_RATE_OFFSET_2", + "DATA_RATE_OFFSET_3", + "DATA_RATE_OFFSET_4", + "DATA_RATE_OFFSET_5", + "DATA_RATE_OFFSET_6", + "DATA_RATE_OFFSET_7" + ] } } }, - "sizes": { - "description": "URLs of the picture for different sizes, if available on a CDN.", + "desired_rx1_delay": { "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "power_state": { - "description": "Power state of the device.", - "type": "string", - "default": "POWER_UNKNOWN", - "enum": [ - "POWER_UNKNOWN", - "POWER_BATTERY", - "POWER_EXTERNAL" - ] - }, - "provisioner_id": { - "description": "ID of the provisioner. Stored in Join Server.", - "type": "string" - }, - "provisioning_data": { - "description": "Vendor-specific provisioning data. Stored in Join Server.", - "type": "object" - }, - "queued_application_downlinks": { - "description": "Queued Application downlink messages. Stored in Application Server,\nwhich sets them on the Network Server.\nThis field is deprecated and is always set equal to session.queued_application_downlinks.", - "type": "array", - "items": { - "type": "object", - "properties": { - "class_b_c": { - "type": "object", - "properties": { - "absolute_time": { - "description": "Absolute time when the downlink message should be transmitted.\nThis requires the gateway to have GPS time synchronization.\nIf the time is in the past or if there is a scheduling conflict, the downlink message fails.\nIf null, the time is selected based on slot availability. This is recommended in class B mode.", - "type": "string", - "format": "date-time" - }, - "gateways": { - "description": "Possible gateway identifiers, antenna index, and group index to use for this downlink message.\nThe Network Server selects one of these gateways for downlink, based on connectivity, signal quality, channel utilization and an available slot.\nIf none of the gateways can be selected, the downlink message fails.\nIf empty, a gateway and antenna is selected automatically from the gateways seen in recent uplinks.\nIf group index is set, gateways will be grouped by the index for the Network Server to select one gateway per group.", - "type": "array", - "items": { - "type": "object", - "properties": { - "antenna_index": { - "type": "integer", - "format": "int64" - }, - "gateway_ids": { - "type": "object", - "properties": { - "eui": { - "description": "Secondary identifier, which can only be used in specific requests.", - "type": "string", - "format": "string", - "example": "70B3D57ED000ABCD" - }, - "gateway_id": { - "type": "string" - } - } - }, - "group_index": { - "type": "integer", - "format": "int64" - } - } - } - } + "properties": { + "value": { + "description": " - RX_DELAY_0: 1 second.\n - RX_DELAY_1: 1 second.\n - RX_DELAY_2: 2 seconds.\n - RX_DELAY_3: 3 seconds.\n - RX_DELAY_4: 4 seconds.\n - RX_DELAY_5: 5 seconds.\n - RX_DELAY_6: 6 seconds.\n - RX_DELAY_7: 7 seconds.\n - RX_DELAY_8: 8 seconds.\n - RX_DELAY_9: 9 seconds.\n - RX_DELAY_10: 10 seconds.\n - RX_DELAY_11: 11 seconds.\n - RX_DELAY_12: 12 seconds.\n - RX_DELAY_13: 13 seconds.\n - RX_DELAY_14: 14 seconds.\n - RX_DELAY_15: 15 seconds.", + "type": "string", + "default": "RX_DELAY_0", + "enum": [ + "RX_DELAY_0", + "RX_DELAY_1", + "RX_DELAY_2", + "RX_DELAY_3", + "RX_DELAY_4", + "RX_DELAY_5", + "RX_DELAY_6", + "RX_DELAY_7", + "RX_DELAY_8", + "RX_DELAY_9", + "RX_DELAY_10", + "RX_DELAY_11", + "RX_DELAY_12", + "RX_DELAY_13", + "RX_DELAY_14", + "RX_DELAY_15" + ] } - }, - "confirmed": { - "type": "boolean" - }, - "confirmed_retry": { - "type": "object", - "properties": { - "attempt": { - "description": "The number of attempted confirmed downlink acknowledgements.", - "type": "integer", - "format": "int64" - }, - "max_attempts": { - "description": "The maximum number of confirmed downlink acknowledgement attempts.\nIf null, the Application Server configuration is used instead.", - "type": "integer", - "format": "int64" - } + } + }, + "desired_rx2_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] } - }, - "correlation_ids": { - "type": "array", - "items": { - "type": "string" + } + }, + "desired_rx2_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" } - }, - "decoded_payload": { - "description": "The decoded frame payload of the downlink message.\nWhen scheduling downlink with a message processor configured for the end device (see formatters) or application (see default_formatters),\nthis fields acts as input for the downlink encoder, and the output is set to frm_payload.\nWhen reading downlink (listing the queue, downlink message events, etc), this fields acts as output of the downlink decoder, and the input is frm_payload.", - "type": "object" - }, - "decoded_payload_warnings": { - "description": "Warnings generated by the message processor while encoding frm_payload (scheduling downlink) or decoding the frm_payload (reading downlink).", - "type": "array", - "items": { - "type": "string" + } + }, + "downlink_dwell_time": { + "type": "object", + "properties": { + "value": { + "type": "boolean" } - }, - "f_cnt": { - "type": "integer", - "format": "int64" - }, - "f_port": { - "type": "integer", - "format": "int64" - }, - "frm_payload": { - "description": "The frame payload of the downlink message.\nThe payload is encrypted if the skip_payload_crypto field of the EndDevice\nis true.", - "type": "string", - "format": "byte" - }, - "priority": { - "type": "string", - "default": "LOWEST", - "enum": [ - "LOWEST", - "LOW", - "BELOW_NORMAL", - "NORMAL", - "ABOVE_NORMAL", - "HIGH", - "HIGHEST" - ] - }, - "session_key_id": { - "description": "Join Server issued identifier for the session keys used by this downlink.", + } + }, + "factory_preset_frequencies": { + "description": "List of factory-preset frequencies.\nIf unset, the default value from Network Server configuration or regional parameters specification will be used.", + "type": "array", + "items": { "type": "string", - "format": "byte" + "format": "uint64" } - } - } - }, - "resets_join_nonces": { - "description": "Whether the device resets the join and dev nonces (not LoRaWAN compliant). Stored in Join Server.\nCopied on creation from template identified by version_ids, if any or from the home Network Server device profile, if any.", - "type": "boolean" - }, - "root_keys": { - "description": "Root keys for a LoRaWAN device.\nThese are stored on the Join Server.", - "type": "object", - "properties": { - "app_key": { + }, + "max_duty_cycle": { "type": "object", "properties": { - "encrypted_key": { - "type": "string", - "format": "byte" - }, - "kek_label": { - "description": "The label of the RFC 3394 key-encryption-key (KEK) that was used to encrypt the key.", - "type": "string" - }, - "key": { - "description": "The unencrypted AES key.", + "value": { + "description": " - DUTY_CYCLE_1: 100%.\n - DUTY_CYCLE_2: 50%.\n - DUTY_CYCLE_4: 25%.\n - DUTY_CYCLE_8: 12.5%.\n - DUTY_CYCLE_16: 6.25%.\n - DUTY_CYCLE_32: 3.125%.\n - DUTY_CYCLE_64: 1.5625%.\n - DUTY_CYCLE_128: Roughly 0.781%.\n - DUTY_CYCLE_256: Roughly 0.390%.\n - DUTY_CYCLE_512: Roughly 0.195%.\n - DUTY_CYCLE_1024: Roughly 0.098%.\n - DUTY_CYCLE_2048: Roughly 0.049%.\n - DUTY_CYCLE_4096: Roughly 0.024%.\n - DUTY_CYCLE_8192: Roughly 0.012%.\n - DUTY_CYCLE_16384: Roughly 0.006%.\n - DUTY_CYCLE_32768: Roughly 0.003%.", "type": "string", - "format": "string", - "example": "0123456789ABCDEF0123456789ABCDEF" + "default": "DUTY_CYCLE_1", + "enum": [ + "DUTY_CYCLE_1", + "DUTY_CYCLE_2", + "DUTY_CYCLE_4", + "DUTY_CYCLE_8", + "DUTY_CYCLE_16", + "DUTY_CYCLE_32", + "DUTY_CYCLE_64", + "DUTY_CYCLE_128", + "DUTY_CYCLE_256", + "DUTY_CYCLE_512", + "DUTY_CYCLE_1024", + "DUTY_CYCLE_2048", + "DUTY_CYCLE_4096", + "DUTY_CYCLE_8192", + "DUTY_CYCLE_16384", + "DUTY_CYCLE_32768" + ] } } }, - "nwk_key": { + "ping_slot_data_rate_index": { "type": "object", "properties": { - "encrypted_key": { + "value": { "type": "string", - "format": "byte" - }, - "kek_label": { - "description": "The label of the RFC 3394 key-encryption-key (KEK) that was used to encrypt the key.", - "type": "string" - }, - "key": { - "description": "The unencrypted AES key.", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "ping_slot_frequency": { + "type": "object", + "properties": { + "value": { "type": "string", - "format": "string", - "example": "0123456789ABCDEF0123456789ABCDEF" + "format": "uint64" } } }, - "root_key_id": { - "description": "Join Server issued identifier for the root keys.", - "type": "string" - } - } - }, - "serial_number": { - "type": "string" - }, - "service_profile_id": { - "description": "Default service profile. Stored in Entity Registry.", - "type": "string" - }, - "session": { - "type": "object", - "properties": { - "dev_addr": { - "description": "Device Address, issued by the Network Server or chosen by device manufacturer in case of testing range (beginning with 00-03).\nKnown by Network Server, Application Server and Join Server. Owned by Network Server.", - "type": "string", - "format": "string", - "example": "2600ABCD" + "ping_slot_periodicity": { + "type": "object", + "properties": { + "value": { + "description": " - PING_EVERY_1S: Every second.\n - PING_EVERY_2S: Every 2 seconds.\n - PING_EVERY_4S: Every 4 seconds.\n - PING_EVERY_8S: Every 8 seconds.\n - PING_EVERY_16S: Every 16 seconds.\n - PING_EVERY_32S: Every 32 seconds.\n - PING_EVERY_64S: Every 64 seconds.\n - PING_EVERY_128S: Every 128 seconds.", + "type": "string", + "default": "PING_EVERY_1S", + "enum": [ + "PING_EVERY_1S", + "PING_EVERY_2S", + "PING_EVERY_4S", + "PING_EVERY_8S", + "PING_EVERY_16S", + "PING_EVERY_32S", + "PING_EVERY_64S", + "PING_EVERY_128S" + ] + } + } }, - "keys": { - "description": "Session keys for a LoRaWAN session.\nOnly the components for which the keys were meant, will have the key-encryption-key (KEK) to decrypt the individual keys.", + "relay": { + "description": "RelaySettings represent the settings of a relay.\nThis is used internally by the Network Server.", "type": "object", "properties": { - "app_s_key": { + "served": { "type": "object", "properties": { - "encrypted_key": { - "type": "string", - "format": "byte" + "always": { + "type": "object" }, - "kek_label": { - "description": "The label of the RFC 3394 key-encryption-key (KEK) that was used to encrypt the key.", - "type": "string" + "backoff": { + "description": "Number of wake on radio frames to be sent without an acknowledgement before sending the uplink message directly.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" }, - "key": { - "description": "The unencrypted AES key.", - "type": "string", - "format": "string", - "example": "0123456789ABCDEF0123456789ABCDEF" - } - } - }, - "f_nwk_s_int_key": { - "type": "object", - "properties": { - "encrypted_key": { - "type": "string", - "format": "byte" + "dynamic": { + "type": "object", + "properties": { + "smart_enable_level": { + "type": "string", + "default": "RELAY_SMART_ENABLE_LEVEL_8", + "enum": [ + "RELAY_SMART_ENABLE_LEVEL_8", + "RELAY_SMART_ENABLE_LEVEL_16", + "RELAY_SMART_ENABLE_LEVEL_32", + "RELAY_SMART_ENABLE_LEVEL_64" + ] + } + } }, - "kek_label": { - "description": "The label of the RFC 3394 key-encryption-key (KEK) that was used to encrypt the key.", - "type": "string" + "end_device_controlled": { + "type": "object" }, - "key": { - "description": "The unencrypted AES key.", - "type": "string", - "format": "string", - "example": "0123456789ABCDEF0123456789ABCDEF" - } - } - }, - "nwk_s_enc_key": { - "type": "object", - "properties": { - "encrypted_key": { - "type": "string", - "format": "byte" + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } }, - "kek_label": { - "description": "The label of the RFC 3394 key-encryption-key (KEK) that was used to encrypt the key.", + "serving_device_id": { + "description": "End device identifier of the serving end device.", "type": "string" - }, - "key": { - "description": "The unencrypted AES key.", - "type": "string", - "format": "string", - "example": "0123456789ABCDEF0123456789ABCDEF" } } }, - "s_nwk_s_int_key": { + "serving": { "type": "object", "properties": { - "encrypted_key": { + "cad_periodicity": { "type": "string", - "format": "byte" + "title": "- RELAY_CAD_PERIODICITY_20_MILLISECONDS: sic", + "default": "RELAY_CAD_PERIODICITY_1_SECOND", + "enum": [ + "RELAY_CAD_PERIODICITY_1_SECOND", + "RELAY_CAD_PERIODICITY_500_MILLISECONDS", + "RELAY_CAD_PERIODICITY_250_MILLISECONDS", + "RELAY_CAD_PERIODICITY_100_MILLISECONDS", + "RELAY_CAD_PERIODICITY_50_MILLISECONDS", + "RELAY_CAD_PERIODICITY_20_MILLISECONDS" + ] }, - "kek_label": { - "description": "The label of the RFC 3394 key-encryption-key (KEK) that was used to encrypt the key.", - "type": "string" + "default_channel_index": { + "description": "Index of the default wake on radio channel.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" }, - "key": { - "description": "The unencrypted AES key.", - "type": "string", - "format": "string", - "example": "0123456789ABCDEF0123456789ABCDEF" - } - } - }, - "session_key_id": { - "description": "Join Server issued identifier for the session keys.\nThis ID can be used to request the keys from the Join Server in case the are lost.", - "type": "string", - "format": "byte" - } - } - }, - "last_a_f_cnt_down": { - "description": "Last application downlink frame counter value used. Application Server only.", - "type": "integer", - "format": "int64" - }, - "last_conf_f_cnt_down": { - "description": "Frame counter of the last confirmed downlink message sent. Network Server only.", - "type": "integer", - "format": "int64" - }, - "last_f_cnt_up": { - "description": "Last uplink frame counter value used. Network Server only. Application Server assumes the Network Server checked it.", - "type": "integer", - "format": "int64" - }, - "last_n_f_cnt_down": { - "description": "Last network downlink frame counter value used. Network Server only.", - "type": "integer", - "format": "int64" - }, - "queued_application_downlinks": { - "description": "Queued Application downlink messages. Stored in Application Server and Network Server.", - "type": "array", - "items": { - "type": "object", - "properties": { - "class_b_c": { - "type": "object", - "properties": { - "absolute_time": { - "description": "Absolute time when the downlink message should be transmitted.\nThis requires the gateway to have GPS time synchronization.\nIf the time is in the past or if there is a scheduling conflict, the downlink message fails.\nIf null, the time is selected based on slot availability. This is recommended in class B mode.", - "type": "string", - "format": "date-time" - }, - "gateways": { - "description": "Possible gateway identifiers, antenna index, and group index to use for this downlink message.\nThe Network Server selects one of these gateways for downlink, based on connectivity, signal quality, channel utilization and an available slot.\nIf none of the gateways can be selected, the downlink message fails.\nIf empty, a gateway and antenna is selected automatically from the gateways seen in recent uplinks.\nIf group index is set, gateways will be grouped by the index for the Network Server to select one gateway per group.", - "type": "array", - "items": { + "limits": { + "type": "object", + "properties": { + "join_requests": { "type": "object", "properties": { - "antenna_index": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", "type": "integer", "format": "int64" + } + } + }, + "notifications": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] }, - "gateway_ids": { - "type": "object", - "properties": { - "eui": { - "description": "Secondary identifier, which can only be used in specific requests.", - "type": "string", - "format": "string", - "example": "70B3D57ED000ABCD" - }, - "gateway_id": { - "type": "string" - } - } + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "overall": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] }, - "group_index": { + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "reset_behavior": { + "type": "string", + "default": "RELAY_RESET_LIMIT_COUNTER_ZERO", + "enum": [ + "RELAY_RESET_LIMIT_COUNTER_ZERO", + "RELAY_RESET_LIMIT_COUNTER_RELOAD_RATE", + "RELAY_RESET_LIMIT_COUNTER_MAX_VALUE", + "RELAY_RESET_LIMIT_COUNTER_NO_RESET" + ] + }, + "uplink_messages": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", "type": "integer", "format": "int64" } } } } - } - }, - "confirmed": { - "type": "boolean" - }, - "confirmed_retry": { - "type": "object", - "properties": { - "attempt": { - "description": "The number of attempted confirmed downlink acknowledgements.", - "type": "integer", - "format": "int64" - }, - "max_attempts": { - "description": "The maximum number of confirmed downlink acknowledgement attempts.\nIf null, the Application Server configuration is used instead.", - "type": "integer", - "format": "int64" + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "uplink_forwarding_rules": { + "description": "Configured uplink forwarding rules.", + "type": "array", + "items": { + "type": "object", + "properties": { + "device_id": { + "description": "End device identifier of the served end device.", + "type": "string" + }, + "last_w_f_cnt": { + "description": "Last wake on radio frame counter used by the served end device.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "session_key_id": { + "description": "Session key ID of the session keys used to derive the root relay session key.", + "type": "string", + "format": "byte" + } + } } } - }, - "correlation_ids": { - "type": "array", - "items": { - "type": "string" - } - }, - "decoded_payload": { - "description": "The decoded frame payload of the downlink message.\nWhen scheduling downlink with a message processor configured for the end device (see formatters) or application (see default_formatters),\nthis fields acts as input for the downlink encoder, and the output is set to frm_payload.\nWhen reading downlink (listing the queue, downlink message events, etc), this fields acts as output of the downlink decoder, and the input is frm_payload.", - "type": "object" - }, - "decoded_payload_warnings": { - "description": "Warnings generated by the message processor while encoding frm_payload (scheduling downlink) or decoding the frm_payload (reading downlink).", - "type": "array", - "items": { - "type": "string" - } - }, - "f_cnt": { - "type": "integer", - "format": "int64" - }, - "f_port": { - "type": "integer", - "format": "int64" - }, - "frm_payload": { - "description": "The frame payload of the downlink message.\nThe payload is encrypted if the skip_payload_crypto field of the EndDevice\nis true.", - "type": "string", - "format": "byte" - }, - "priority": { - "type": "string", - "default": "LOWEST", - "enum": [ - "LOWEST", - "LOW", - "BELOW_NORMAL", - "NORMAL", - "ABOVE_NORMAL", - "HIGH", - "HIGHEST" - ] - }, - "session_key_id": { - "description": "Join Server issued identifier for the session keys used by this downlink.", - "type": "string", - "format": "byte" } } } }, - "started_at": { - "description": "Time when the session started. Network Server only.", - "type": "string", - "format": "date-time" - } - } - }, - "skip_payload_crypto": { - "description": "Skip decryption of uplink payloads and encryption of downlink payloads.\nThis field is deprecated, use skip_payload_crypto_override instead.", - "type": "boolean" - }, - "skip_payload_crypto_override": { - "description": "Skip decryption of uplink payloads and encryption of downlink payloads.\nThis field overrides the application-level setting.", - "type": "boolean" - }, - "supports_class_b": { - "description": "Whether the device supports class B.\nCopied on creation from template identified by version_ids, if any or from the home Network Server device profile, if any.", - "type": "boolean" - }, - "supports_class_c": { - "description": "Whether the device supports class C.\nCopied on creation from template identified by version_ids, if any or from the home Network Server device profile, if any.", - "type": "boolean" - }, - "supports_join": { - "description": "The device supports join (it's OTAA).\nCopied on creation from template identified by version_ids, if any or from the home Network Server device profile, if any.", - "type": "boolean" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "used_dev_nonces": { - "description": "Used DevNonces sorted in ascending order.\nThis field is only used for devices using LoRaWAN versions preceding 1.1.\nStored in Join Server.", - "type": "array", - "items": { - "type": "integer", - "format": "int64" - } - }, - "version_ids": { - "description": "Identifies an end device model with version information.", - "type": "object", - "properties": { - "band_id": { - "type": "string" + "resets_f_cnt": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } }, - "brand_id": { - "type": "string" + "rx1_data_rate_offset": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_OFFSET_0", + "enum": [ + "DATA_RATE_OFFSET_0", + "DATA_RATE_OFFSET_1", + "DATA_RATE_OFFSET_2", + "DATA_RATE_OFFSET_3", + "DATA_RATE_OFFSET_4", + "DATA_RATE_OFFSET_5", + "DATA_RATE_OFFSET_6", + "DATA_RATE_OFFSET_7" + ] + } + } }, - "firmware_version": { - "type": "string" + "rx1_delay": { + "type": "object", + "properties": { + "value": { + "description": " - RX_DELAY_0: 1 second.\n - RX_DELAY_1: 1 second.\n - RX_DELAY_2: 2 seconds.\n - RX_DELAY_3: 3 seconds.\n - RX_DELAY_4: 4 seconds.\n - RX_DELAY_5: 5 seconds.\n - RX_DELAY_6: 6 seconds.\n - RX_DELAY_7: 7 seconds.\n - RX_DELAY_8: 8 seconds.\n - RX_DELAY_9: 9 seconds.\n - RX_DELAY_10: 10 seconds.\n - RX_DELAY_11: 11 seconds.\n - RX_DELAY_12: 12 seconds.\n - RX_DELAY_13: 13 seconds.\n - RX_DELAY_14: 14 seconds.\n - RX_DELAY_15: 15 seconds.", + "type": "string", + "default": "RX_DELAY_0", + "enum": [ + "RX_DELAY_0", + "RX_DELAY_1", + "RX_DELAY_2", + "RX_DELAY_3", + "RX_DELAY_4", + "RX_DELAY_5", + "RX_DELAY_6", + "RX_DELAY_7", + "RX_DELAY_8", + "RX_DELAY_9", + "RX_DELAY_10", + "RX_DELAY_11", + "RX_DELAY_12", + "RX_DELAY_13", + "RX_DELAY_14", + "RX_DELAY_15" + ] + } + } }, - "hardware_version": { - "type": "string" + "rx2_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } }, - "model_id": { + "rx2_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "schedule_downlinks": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "status_count_periodicity": { + "description": "Number of uplink messages after which a DevStatusReq MACCommand shall be sent.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "status_time_periodicity": { + "description": "The interval after which a DevStatusReq MACCommand shall be sent.\nIf unset, the default value from Network Server configuration will be used.", "type": "string" + }, + "supports_32_bit_f_cnt": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "uplink_dwell_time": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "use_adr": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } } } } } }, - "field_mask": { - "description": "The names of the end device fields that should be updated.\nSee the API reference for which fields can be set on the different services.", - "type": "string" + "mac_settings_profile_ids": { + "description": "The identifiers of the MAC settings profile.", + "type": "object", + "title": "The identifiers of the MAC settings profile.", + "properties": { + "application_ids": { + "description": "Application IDs.", + "type": "object", + "title": "Application IDs." + } + } } } }, @@ -656712,15 +679795,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -656738,6 +679824,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -656752,11 +679839,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -656770,6 +679859,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -656779,6 +679869,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -656837,15 +679948,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -656863,6 +679977,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -656877,11 +679992,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -656895,6 +680012,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -656904,6 +680022,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -656947,15 +680086,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -656973,6 +680115,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -656987,11 +680130,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -657005,6 +680150,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -657014,6 +680160,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -657060,15 +680227,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -657086,6 +680256,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -657100,11 +680271,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -657118,6 +680291,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -657127,6 +680301,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -657326,15 +680521,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -657352,6 +680550,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -657366,11 +680565,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -657384,6 +680585,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -657393,6 +680595,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -657436,15 +680659,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -657462,6 +680688,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -657476,11 +680703,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -657494,6 +680723,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -657503,6 +680733,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -657540,15 +680791,18 @@ "description": "Rights that are granted to this API key.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -657566,6 +680820,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -657580,11 +680835,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -657598,6 +680855,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -657607,6 +680865,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -672400,15 +695679,18 @@ } }, "v3Right": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -672426,6 +695708,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -672440,11 +695723,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -672458,6 +695743,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -672467,6 +695753,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] }, @@ -672476,15 +695783,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -672502,6 +695812,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -672516,11 +695827,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -672534,6 +695847,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -672543,6 +695857,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -676483,6 +699818,15 @@ } } }, + "v3Tutorial": { + "description": "Tutorial is a set of possible tutorials in the Console.", + "type": "string", + "default": "TUTORIAL_UNKNOWN", + "enum": [ + "TUTORIAL_UNKNOWN", + "TUTORIAL_LIVE_DATA_SPLIT_VIEW" + ] + }, "v3TxAcknowledgment": { "type": "object", "properties": { @@ -677366,6 +700710,1537 @@ "HIGHEST" ] }, + "v3UpdateMACSettingsProfileResponse": { + "type": "object", + "properties": { + "mac_settings_profile": { + "type": "object", + "properties": { + "ids": { + "type": "object", + "properties": { + "application_ids": { + "type": "object", + "properties": { + "application_id": { + "type": "string" + } + } + }, + "profile_id": { + "description": "Profile ID.", + "type": "string" + } + } + }, + "mac_settings": { + "type": "object", + "properties": { + "adr": { + "description": "Adaptive Data Rate settings.", + "type": "object", + "properties": { + "disabled": { + "description": "Configuration options for cases in which ADR is to be disabled\ncompletely.", + "type": "object" + }, + "dynamic": { + "description": "Configuration options for dynamic ADR.", + "type": "object", + "properties": { + "channel_steering": { + "description": "EXPERIMENTAL: Channel steering settings.", + "type": "object", + "properties": { + "disabled": { + "description": "Configuration options for cases in which ADR is not supposed to steer the end device\nto another set of channels.", + "type": "object" + }, + "lora_narrow": { + "description": "Configuration options for LoRa narrow channels steering.\nThe narrow mode attempts to steer the end device towards\nusing the LoRa modulated, 125kHz bandwidth channels.", + "type": "object" + } + } + }, + "margin": { + "description": "The ADR margin (dB) tells the network server how much margin it should add in ADR requests.\nA bigger margin is less efficient, but gives a better chance of successful reception.\nIf unset, the default value from Network Server configuration will be used.", + "type": "number", + "format": "float" + }, + "max_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "max_tx_power_index": { + "description": "Maximum transmission power index.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_tx_power_index": { + "description": "Minimum transmission power index.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "overrides": { + "description": "EXPERIMENTAL: Configuration overrides.", + "type": "object", + "properties": { + "data_rate_0": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_1": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_10": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_11": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_12": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_13": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_14": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_15": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_2": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_3": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_4": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_5": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_6": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_7": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_8": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + }, + "data_rate_9": { + "description": "EXPERIMENTAL: Data rate index override settings.", + "type": "object", + "properties": { + "max_nb_trans": { + "description": "Maximum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "min_nb_trans": { + "description": "Minimum number of retransmissions.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + } + } + } + } + } + } + }, + "static": { + "description": "Configuration options for static ADR.", + "type": "object", + "properties": { + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "nb_trans": { + "description": "Number of retransmissions.", + "type": "integer", + "format": "int64" + }, + "tx_power_index": { + "description": "Transmission power index to use.", + "type": "integer", + "format": "int64" + } + } + } + } + }, + "adr_margin": { + "description": "The ADR margin (dB) tells the network server how much margin it should add in ADR requests.\nA bigger margin is less efficient, but gives a better chance of successful reception.\nThis field is deprecated, use adr_settings.dynamic.margin instead.", + "type": "number", + "format": "float" + }, + "beacon_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "class_b_c_downlink_interval": { + "description": "The minimum duration passed before a network-initiated(e.g. Class B or C) downlink following an arbitrary downlink.", + "type": "string" + }, + "class_b_timeout": { + "description": "Maximum delay for the device to answer a MAC request or a confirmed downlink frame.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "class_c_timeout": { + "description": "Maximum delay for the device to answer a MAC request or a confirmed downlink frame.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "desired_adr_ack_delay_exponent": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "ADR_ACK_DELAY_1", + "enum": [ + "ADR_ACK_DELAY_1", + "ADR_ACK_DELAY_2", + "ADR_ACK_DELAY_4", + "ADR_ACK_DELAY_8", + "ADR_ACK_DELAY_16", + "ADR_ACK_DELAY_32", + "ADR_ACK_DELAY_64", + "ADR_ACK_DELAY_128", + "ADR_ACK_DELAY_256", + "ADR_ACK_DELAY_512", + "ADR_ACK_DELAY_1024", + "ADR_ACK_DELAY_2048", + "ADR_ACK_DELAY_4096", + "ADR_ACK_DELAY_8192", + "ADR_ACK_DELAY_16384", + "ADR_ACK_DELAY_32768" + ] + } + } + }, + "desired_adr_ack_limit_exponent": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "ADR_ACK_LIMIT_1", + "enum": [ + "ADR_ACK_LIMIT_1", + "ADR_ACK_LIMIT_2", + "ADR_ACK_LIMIT_4", + "ADR_ACK_LIMIT_8", + "ADR_ACK_LIMIT_16", + "ADR_ACK_LIMIT_32", + "ADR_ACK_LIMIT_64", + "ADR_ACK_LIMIT_128", + "ADR_ACK_LIMIT_256", + "ADR_ACK_LIMIT_512", + "ADR_ACK_LIMIT_1024", + "ADR_ACK_LIMIT_2048", + "ADR_ACK_LIMIT_4096", + "ADR_ACK_LIMIT_8192", + "ADR_ACK_LIMIT_16384", + "ADR_ACK_LIMIT_32768" + ] + } + } + }, + "desired_beacon_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "desired_max_duty_cycle": { + "type": "object", + "properties": { + "value": { + "description": " - DUTY_CYCLE_1: 100%.\n - DUTY_CYCLE_2: 50%.\n - DUTY_CYCLE_4: 25%.\n - DUTY_CYCLE_8: 12.5%.\n - DUTY_CYCLE_16: 6.25%.\n - DUTY_CYCLE_32: 3.125%.\n - DUTY_CYCLE_64: 1.5625%.\n - DUTY_CYCLE_128: Roughly 0.781%.\n - DUTY_CYCLE_256: Roughly 0.390%.\n - DUTY_CYCLE_512: Roughly 0.195%.\n - DUTY_CYCLE_1024: Roughly 0.098%.\n - DUTY_CYCLE_2048: Roughly 0.049%.\n - DUTY_CYCLE_4096: Roughly 0.024%.\n - DUTY_CYCLE_8192: Roughly 0.012%.\n - DUTY_CYCLE_16384: Roughly 0.006%.\n - DUTY_CYCLE_32768: Roughly 0.003%.", + "type": "string", + "default": "DUTY_CYCLE_1", + "enum": [ + "DUTY_CYCLE_1", + "DUTY_CYCLE_2", + "DUTY_CYCLE_4", + "DUTY_CYCLE_8", + "DUTY_CYCLE_16", + "DUTY_CYCLE_32", + "DUTY_CYCLE_64", + "DUTY_CYCLE_128", + "DUTY_CYCLE_256", + "DUTY_CYCLE_512", + "DUTY_CYCLE_1024", + "DUTY_CYCLE_2048", + "DUTY_CYCLE_4096", + "DUTY_CYCLE_8192", + "DUTY_CYCLE_16384", + "DUTY_CYCLE_32768" + ] + } + } + }, + "desired_max_eirp": { + "type": "object", + "properties": { + "value": { + "description": " - DEVICE_EIRP_8: 8 dBm.\n - DEVICE_EIRP_10: 10 dBm.\n - DEVICE_EIRP_12: 12 dBm.\n - DEVICE_EIRP_13: 13 dBm.\n - DEVICE_EIRP_14: 14 dBm.\n - DEVICE_EIRP_16: 16 dBm.\n - DEVICE_EIRP_18: 18 dBm.\n - DEVICE_EIRP_20: 20 dBm.\n - DEVICE_EIRP_21: 21 dBm.\n - DEVICE_EIRP_24: 24 dBm.\n - DEVICE_EIRP_26: 26 dBm.\n - DEVICE_EIRP_27: 27 dBm.\n - DEVICE_EIRP_29: 29 dBm.\n - DEVICE_EIRP_30: 30 dBm.\n - DEVICE_EIRP_33: 33 dBm.\n - DEVICE_EIRP_36: 36 dBm.", + "type": "string", + "default": "DEVICE_EIRP_8", + "enum": [ + "DEVICE_EIRP_8", + "DEVICE_EIRP_10", + "DEVICE_EIRP_12", + "DEVICE_EIRP_13", + "DEVICE_EIRP_14", + "DEVICE_EIRP_16", + "DEVICE_EIRP_18", + "DEVICE_EIRP_20", + "DEVICE_EIRP_21", + "DEVICE_EIRP_24", + "DEVICE_EIRP_26", + "DEVICE_EIRP_27", + "DEVICE_EIRP_29", + "DEVICE_EIRP_30", + "DEVICE_EIRP_33", + "DEVICE_EIRP_36" + ] + } + } + }, + "desired_ping_slot_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "desired_ping_slot_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "desired_relay": { + "description": "RelaySettings represent the settings of a relay.\nThis is used internally by the Network Server.", + "type": "object", + "properties": { + "served": { + "type": "object", + "properties": { + "always": { + "type": "object" + }, + "backoff": { + "description": "Number of wake on radio frames to be sent without an acknowledgement before sending the uplink message directly.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "dynamic": { + "type": "object", + "properties": { + "smart_enable_level": { + "type": "string", + "default": "RELAY_SMART_ENABLE_LEVEL_8", + "enum": [ + "RELAY_SMART_ENABLE_LEVEL_8", + "RELAY_SMART_ENABLE_LEVEL_16", + "RELAY_SMART_ENABLE_LEVEL_32", + "RELAY_SMART_ENABLE_LEVEL_64" + ] + } + } + }, + "end_device_controlled": { + "type": "object" + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "serving_device_id": { + "description": "End device identifier of the serving end device.", + "type": "string" + } + } + }, + "serving": { + "type": "object", + "properties": { + "cad_periodicity": { + "type": "string", + "title": "- RELAY_CAD_PERIODICITY_20_MILLISECONDS: sic", + "default": "RELAY_CAD_PERIODICITY_1_SECOND", + "enum": [ + "RELAY_CAD_PERIODICITY_1_SECOND", + "RELAY_CAD_PERIODICITY_500_MILLISECONDS", + "RELAY_CAD_PERIODICITY_250_MILLISECONDS", + "RELAY_CAD_PERIODICITY_100_MILLISECONDS", + "RELAY_CAD_PERIODICITY_50_MILLISECONDS", + "RELAY_CAD_PERIODICITY_20_MILLISECONDS" + ] + }, + "default_channel_index": { + "description": "Index of the default wake on radio channel.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "join_requests": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "notifications": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "overall": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "reset_behavior": { + "type": "string", + "default": "RELAY_RESET_LIMIT_COUNTER_ZERO", + "enum": [ + "RELAY_RESET_LIMIT_COUNTER_ZERO", + "RELAY_RESET_LIMIT_COUNTER_RELOAD_RATE", + "RELAY_RESET_LIMIT_COUNTER_MAX_VALUE", + "RELAY_RESET_LIMIT_COUNTER_NO_RESET" + ] + }, + "uplink_messages": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + } + } + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "uplink_forwarding_rules": { + "description": "Configured uplink forwarding rules.", + "type": "array", + "items": { + "type": "object", + "properties": { + "device_id": { + "description": "End device identifier of the served end device.", + "type": "string" + }, + "last_w_f_cnt": { + "description": "Last wake on radio frame counter used by the served end device.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "session_key_id": { + "description": "Session key ID of the session keys used to derive the root relay session key.", + "type": "string", + "format": "byte" + } + } + } + } + } + } + } + }, + "desired_rx1_data_rate_offset": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_OFFSET_0", + "enum": [ + "DATA_RATE_OFFSET_0", + "DATA_RATE_OFFSET_1", + "DATA_RATE_OFFSET_2", + "DATA_RATE_OFFSET_3", + "DATA_RATE_OFFSET_4", + "DATA_RATE_OFFSET_5", + "DATA_RATE_OFFSET_6", + "DATA_RATE_OFFSET_7" + ] + } + } + }, + "desired_rx1_delay": { + "type": "object", + "properties": { + "value": { + "description": " - RX_DELAY_0: 1 second.\n - RX_DELAY_1: 1 second.\n - RX_DELAY_2: 2 seconds.\n - RX_DELAY_3: 3 seconds.\n - RX_DELAY_4: 4 seconds.\n - RX_DELAY_5: 5 seconds.\n - RX_DELAY_6: 6 seconds.\n - RX_DELAY_7: 7 seconds.\n - RX_DELAY_8: 8 seconds.\n - RX_DELAY_9: 9 seconds.\n - RX_DELAY_10: 10 seconds.\n - RX_DELAY_11: 11 seconds.\n - RX_DELAY_12: 12 seconds.\n - RX_DELAY_13: 13 seconds.\n - RX_DELAY_14: 14 seconds.\n - RX_DELAY_15: 15 seconds.", + "type": "string", + "default": "RX_DELAY_0", + "enum": [ + "RX_DELAY_0", + "RX_DELAY_1", + "RX_DELAY_2", + "RX_DELAY_3", + "RX_DELAY_4", + "RX_DELAY_5", + "RX_DELAY_6", + "RX_DELAY_7", + "RX_DELAY_8", + "RX_DELAY_9", + "RX_DELAY_10", + "RX_DELAY_11", + "RX_DELAY_12", + "RX_DELAY_13", + "RX_DELAY_14", + "RX_DELAY_15" + ] + } + } + }, + "desired_rx2_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "desired_rx2_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "downlink_dwell_time": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "factory_preset_frequencies": { + "description": "List of factory-preset frequencies.\nIf unset, the default value from Network Server configuration or regional parameters specification will be used.", + "type": "array", + "items": { + "type": "string", + "format": "uint64" + } + }, + "max_duty_cycle": { + "type": "object", + "properties": { + "value": { + "description": " - DUTY_CYCLE_1: 100%.\n - DUTY_CYCLE_2: 50%.\n - DUTY_CYCLE_4: 25%.\n - DUTY_CYCLE_8: 12.5%.\n - DUTY_CYCLE_16: 6.25%.\n - DUTY_CYCLE_32: 3.125%.\n - DUTY_CYCLE_64: 1.5625%.\n - DUTY_CYCLE_128: Roughly 0.781%.\n - DUTY_CYCLE_256: Roughly 0.390%.\n - DUTY_CYCLE_512: Roughly 0.195%.\n - DUTY_CYCLE_1024: Roughly 0.098%.\n - DUTY_CYCLE_2048: Roughly 0.049%.\n - DUTY_CYCLE_4096: Roughly 0.024%.\n - DUTY_CYCLE_8192: Roughly 0.012%.\n - DUTY_CYCLE_16384: Roughly 0.006%.\n - DUTY_CYCLE_32768: Roughly 0.003%.", + "type": "string", + "default": "DUTY_CYCLE_1", + "enum": [ + "DUTY_CYCLE_1", + "DUTY_CYCLE_2", + "DUTY_CYCLE_4", + "DUTY_CYCLE_8", + "DUTY_CYCLE_16", + "DUTY_CYCLE_32", + "DUTY_CYCLE_64", + "DUTY_CYCLE_128", + "DUTY_CYCLE_256", + "DUTY_CYCLE_512", + "DUTY_CYCLE_1024", + "DUTY_CYCLE_2048", + "DUTY_CYCLE_4096", + "DUTY_CYCLE_8192", + "DUTY_CYCLE_16384", + "DUTY_CYCLE_32768" + ] + } + } + }, + "ping_slot_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "ping_slot_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "ping_slot_periodicity": { + "type": "object", + "properties": { + "value": { + "description": " - PING_EVERY_1S: Every second.\n - PING_EVERY_2S: Every 2 seconds.\n - PING_EVERY_4S: Every 4 seconds.\n - PING_EVERY_8S: Every 8 seconds.\n - PING_EVERY_16S: Every 16 seconds.\n - PING_EVERY_32S: Every 32 seconds.\n - PING_EVERY_64S: Every 64 seconds.\n - PING_EVERY_128S: Every 128 seconds.", + "type": "string", + "default": "PING_EVERY_1S", + "enum": [ + "PING_EVERY_1S", + "PING_EVERY_2S", + "PING_EVERY_4S", + "PING_EVERY_8S", + "PING_EVERY_16S", + "PING_EVERY_32S", + "PING_EVERY_64S", + "PING_EVERY_128S" + ] + } + } + }, + "relay": { + "description": "RelaySettings represent the settings of a relay.\nThis is used internally by the Network Server.", + "type": "object", + "properties": { + "served": { + "type": "object", + "properties": { + "always": { + "type": "object" + }, + "backoff": { + "description": "Number of wake on radio frames to be sent without an acknowledgement before sending the uplink message directly.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "dynamic": { + "type": "object", + "properties": { + "smart_enable_level": { + "type": "string", + "default": "RELAY_SMART_ENABLE_LEVEL_8", + "enum": [ + "RELAY_SMART_ENABLE_LEVEL_8", + "RELAY_SMART_ENABLE_LEVEL_16", + "RELAY_SMART_ENABLE_LEVEL_32", + "RELAY_SMART_ENABLE_LEVEL_64" + ] + } + } + }, + "end_device_controlled": { + "type": "object" + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "serving_device_id": { + "description": "End device identifier of the serving end device.", + "type": "string" + } + } + }, + "serving": { + "type": "object", + "properties": { + "cad_periodicity": { + "type": "string", + "title": "- RELAY_CAD_PERIODICITY_20_MILLISECONDS: sic", + "default": "RELAY_CAD_PERIODICITY_1_SECOND", + "enum": [ + "RELAY_CAD_PERIODICITY_1_SECOND", + "RELAY_CAD_PERIODICITY_500_MILLISECONDS", + "RELAY_CAD_PERIODICITY_250_MILLISECONDS", + "RELAY_CAD_PERIODICITY_100_MILLISECONDS", + "RELAY_CAD_PERIODICITY_50_MILLISECONDS", + "RELAY_CAD_PERIODICITY_20_MILLISECONDS" + ] + }, + "default_channel_index": { + "description": "Index of the default wake on radio channel.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "join_requests": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "notifications": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "overall": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "reset_behavior": { + "type": "string", + "default": "RELAY_RESET_LIMIT_COUNTER_ZERO", + "enum": [ + "RELAY_RESET_LIMIT_COUNTER_ZERO", + "RELAY_RESET_LIMIT_COUNTER_RELOAD_RATE", + "RELAY_RESET_LIMIT_COUNTER_MAX_VALUE", + "RELAY_RESET_LIMIT_COUNTER_NO_RESET" + ] + }, + "uplink_messages": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + } + } + }, + "second_channel": { + "type": "object", + "properties": { + "ack_offset": { + "type": "string", + "title": "- RELAY_SECOND_CH_ACK_OFFSET_0: 0 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_200: 200 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_400: 400 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_800: 800 kHz\n - RELAY_SECOND_CH_ACK_OFFSET_1600: 1.6 MHz\n - RELAY_SECOND_CH_ACK_OFFSET_3200: 3.2 MHz", + "default": "RELAY_SECOND_CH_ACK_OFFSET_0", + "enum": [ + "RELAY_SECOND_CH_ACK_OFFSET_0", + "RELAY_SECOND_CH_ACK_OFFSET_200", + "RELAY_SECOND_CH_ACK_OFFSET_400", + "RELAY_SECOND_CH_ACK_OFFSET_800", + "RELAY_SECOND_CH_ACK_OFFSET_1600", + "RELAY_SECOND_CH_ACK_OFFSET_3200" + ] + }, + "data_rate_index": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + }, + "frequency": { + "description": "The frequency (Hz) used by the wake on radio message.", + "type": "string", + "format": "uint64" + } + } + }, + "uplink_forwarding_rules": { + "description": "Configured uplink forwarding rules.", + "type": "array", + "items": { + "type": "object", + "properties": { + "device_id": { + "description": "End device identifier of the served end device.", + "type": "string" + }, + "last_w_f_cnt": { + "description": "Last wake on radio frame counter used by the served end device.", + "type": "integer", + "format": "int64" + }, + "limits": { + "type": "object", + "properties": { + "bucket_size": { + "type": "string", + "title": "- RELAY_LIMIT_BUCKET_SIZE_12: sic", + "default": "RELAY_LIMIT_BUCKET_SIZE_1", + "enum": [ + "RELAY_LIMIT_BUCKET_SIZE_1", + "RELAY_LIMIT_BUCKET_SIZE_2", + "RELAY_LIMIT_BUCKET_SIZE_4", + "RELAY_LIMIT_BUCKET_SIZE_12" + ] + }, + "reload_rate": { + "description": "The number of tokens which are replenished in the bucket every hour.", + "type": "integer", + "format": "int64" + } + } + }, + "session_key_id": { + "description": "Session key ID of the session keys used to derive the root relay session key.", + "type": "string", + "format": "byte" + } + } + } + } + } + } + } + }, + "resets_f_cnt": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "rx1_data_rate_offset": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_OFFSET_0", + "enum": [ + "DATA_RATE_OFFSET_0", + "DATA_RATE_OFFSET_1", + "DATA_RATE_OFFSET_2", + "DATA_RATE_OFFSET_3", + "DATA_RATE_OFFSET_4", + "DATA_RATE_OFFSET_5", + "DATA_RATE_OFFSET_6", + "DATA_RATE_OFFSET_7" + ] + } + } + }, + "rx1_delay": { + "type": "object", + "properties": { + "value": { + "description": " - RX_DELAY_0: 1 second.\n - RX_DELAY_1: 1 second.\n - RX_DELAY_2: 2 seconds.\n - RX_DELAY_3: 3 seconds.\n - RX_DELAY_4: 4 seconds.\n - RX_DELAY_5: 5 seconds.\n - RX_DELAY_6: 6 seconds.\n - RX_DELAY_7: 7 seconds.\n - RX_DELAY_8: 8 seconds.\n - RX_DELAY_9: 9 seconds.\n - RX_DELAY_10: 10 seconds.\n - RX_DELAY_11: 11 seconds.\n - RX_DELAY_12: 12 seconds.\n - RX_DELAY_13: 13 seconds.\n - RX_DELAY_14: 14 seconds.\n - RX_DELAY_15: 15 seconds.", + "type": "string", + "default": "RX_DELAY_0", + "enum": [ + "RX_DELAY_0", + "RX_DELAY_1", + "RX_DELAY_2", + "RX_DELAY_3", + "RX_DELAY_4", + "RX_DELAY_5", + "RX_DELAY_6", + "RX_DELAY_7", + "RX_DELAY_8", + "RX_DELAY_9", + "RX_DELAY_10", + "RX_DELAY_11", + "RX_DELAY_12", + "RX_DELAY_13", + "RX_DELAY_14", + "RX_DELAY_15" + ] + } + } + }, + "rx2_data_rate_index": { + "type": "object", + "properties": { + "value": { + "type": "string", + "default": "DATA_RATE_0", + "enum": [ + "DATA_RATE_0", + "DATA_RATE_1", + "DATA_RATE_2", + "DATA_RATE_3", + "DATA_RATE_4", + "DATA_RATE_5", + "DATA_RATE_6", + "DATA_RATE_7", + "DATA_RATE_8", + "DATA_RATE_9", + "DATA_RATE_10", + "DATA_RATE_11", + "DATA_RATE_12", + "DATA_RATE_13", + "DATA_RATE_14", + "DATA_RATE_15" + ] + } + } + }, + "rx2_frequency": { + "type": "object", + "properties": { + "value": { + "type": "string", + "format": "uint64" + } + } + }, + "schedule_downlinks": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "status_count_periodicity": { + "description": "Number of uplink messages after which a DevStatusReq MACCommand shall be sent.\nIf unset, the default value from Network Server configuration will be used.", + "type": "integer", + "format": "int64" + }, + "status_time_periodicity": { + "description": "The interval after which a DevStatusReq MACCommand shall be sent.\nIf unset, the default value from Network Server configuration will be used.", + "type": "string" + }, + "supports_32_bit_f_cnt": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "uplink_dwell_time": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + }, + "use_adr": { + "type": "object", + "properties": { + "value": { + "type": "boolean" + } + } + } + } + } + } + } + } + }, "v3UpdatePacketBrokerGatewayResponse": { "type": "object", "properties": { @@ -677872,6 +702747,23 @@ "type": "string" } } + }, + "tutorials": { + "type": "object", + "properties": { + "seen": { + "type": "array", + "items": { + "description": "Tutorial is a set of possible tutorials in the Console.", + "type": "string", + "default": "TUTORIAL_UNKNOWN", + "enum": [ + "TUTORIAL_UNKNOWN", + "TUTORIAL_LIVE_DATA_SPLIT_VIEW" + ] + } + } + } } } }, @@ -677927,6 +702819,34 @@ "description": "A description for the user. This information is public and can be seen by any authenticated user in the network.", "type": "string" }, + "email_notification_preferences": { + "description": "EmailNotificationPreferences is the message that defines the types of notifications for which the user wants to receive an email.", + "type": "object", + "properties": { + "types": { + "type": "array", + "items": { + "type": "string", + "default": "UNKNOWN", + "enum": [ + "UNKNOWN", + "API_KEY_CREATED", + "API_KEY_CHANGED", + "CLIENT_REQUESTED", + "COLLABORATOR_CHANGED", + "ENTITY_STATE_CHANGED", + "INVITATION", + "LOGIN_TOKEN", + "PASSWORD_CHANGED", + "TEMPORARY_PASSWORD", + "USER_REQUESTED", + "VALIDATE", + "SUPPORT_ACCESS_REQUESTED" + ] + } + } + } + }, "gateway_limit": { "description": "The maximum number of gateways of the user.\nThis field can only be modified by admins.", "type": "string", @@ -678028,6 +702948,109 @@ "type": "string", "format": "date-time" }, + "universal_rights": { + "description": "Universal rights are capable of restricting the user's interactions with the API, be it an admin or not.", + "type": "array", + "items": { + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "type": "string", + "default": "right_invalid", + "enum": [ + "right_invalid", + "RIGHT_USER_INFO", + "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", + "RIGHT_USER_SETTINGS_API_KEYS", + "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", + "RIGHT_USER_AUTHORIZED_CLIENTS", + "RIGHT_USER_APPLICATIONS_LIST", + "RIGHT_USER_APPLICATIONS_CREATE", + "RIGHT_USER_GATEWAYS_LIST", + "RIGHT_USER_GATEWAYS_CREATE", + "RIGHT_USER_CLIENTS_LIST", + "RIGHT_USER_CLIENTS_CREATE", + "RIGHT_USER_ORGANIZATIONS_LIST", + "RIGHT_USER_ORGANIZATIONS_CREATE", + "RIGHT_USER_NOTIFICATIONS_READ", + "RIGHT_USER_ALL", + "RIGHT_APPLICATION_INFO", + "RIGHT_APPLICATION_SETTINGS_BASIC", + "RIGHT_APPLICATION_SETTINGS_API_KEYS", + "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", + "RIGHT_APPLICATION_SETTINGS_PACKAGES", + "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", + "RIGHT_APPLICATION_DEVICES_READ", + "RIGHT_APPLICATION_DEVICES_WRITE", + "RIGHT_APPLICATION_DEVICES_READ_KEYS", + "RIGHT_APPLICATION_DEVICES_WRITE_KEYS", + "RIGHT_APPLICATION_TRAFFIC_READ", + "RIGHT_APPLICATION_TRAFFIC_UP_WRITE", + "RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE", + "RIGHT_APPLICATION_LINK", + "RIGHT_APPLICATION_ALL", + "RIGHT_CLIENT_ALL", + "RIGHT_CLIENT_INFO", + "RIGHT_CLIENT_SETTINGS_BASIC", + "RIGHT_CLIENT_SETTINGS_COLLABORATORS", + "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", + "RIGHT_GATEWAY_INFO", + "RIGHT_GATEWAY_SETTINGS_BASIC", + "RIGHT_GATEWAY_SETTINGS_API_KEYS", + "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", + "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", + "RIGHT_GATEWAY_TRAFFIC_READ", + "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", + "RIGHT_GATEWAY_LINK", + "RIGHT_GATEWAY_STATUS_READ", + "RIGHT_GATEWAY_LOCATION_READ", + "RIGHT_GATEWAY_WRITE_SECRETS", + "RIGHT_GATEWAY_READ_SECRETS", + "RIGHT_GATEWAY_ALL", + "RIGHT_ORGANIZATION_INFO", + "RIGHT_ORGANIZATION_SETTINGS_BASIC", + "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", + "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", + "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", + "RIGHT_ORGANIZATION_APPLICATIONS_LIST", + "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", + "RIGHT_ORGANIZATION_GATEWAYS_LIST", + "RIGHT_ORGANIZATION_GATEWAYS_CREATE", + "RIGHT_ORGANIZATION_CLIENTS_LIST", + "RIGHT_ORGANIZATION_CLIENTS_CREATE", + "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", + "RIGHT_ORGANIZATION_ALL", + "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", + "RIGHT_ALL" + ] + } + }, "updated_at": { "description": "When the user was last updated. This information is public and can be seen by any authenticated user in the network.", "type": "string", @@ -678048,15 +703071,18 @@ "rights": { "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -678074,6 +703100,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -678088,11 +703115,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -678106,6 +703135,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -678115,6 +703145,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -678156,15 +703207,18 @@ "description": "Rights that are granted to this API key.", "type": "array", "items": { - "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", "type": "string", "default": "right_invalid", "enum": [ "right_invalid", "RIGHT_USER_INFO", "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", "RIGHT_USER_SETTINGS_API_KEYS", "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", "RIGHT_USER_AUTHORIZED_CLIENTS", "RIGHT_USER_APPLICATIONS_LIST", "RIGHT_USER_APPLICATIONS_CREATE", @@ -678182,6 +703236,7 @@ "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", "RIGHT_APPLICATION_SETTINGS_PACKAGES", "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", "RIGHT_APPLICATION_DEVICES_READ", "RIGHT_APPLICATION_DEVICES_WRITE", "RIGHT_APPLICATION_DEVICES_READ_KEYS", @@ -678196,11 +703251,13 @@ "RIGHT_CLIENT_SETTINGS_BASIC", "RIGHT_CLIENT_SETTINGS_COLLABORATORS", "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", "RIGHT_GATEWAY_INFO", "RIGHT_GATEWAY_SETTINGS_BASIC", "RIGHT_GATEWAY_SETTINGS_API_KEYS", "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", "RIGHT_GATEWAY_TRAFFIC_READ", "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", "RIGHT_GATEWAY_LINK", @@ -678214,6 +703271,7 @@ "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", "RIGHT_ORGANIZATION_APPLICATIONS_LIST", "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", "RIGHT_ORGANIZATION_GATEWAYS_LIST", @@ -678223,6 +703281,27 @@ "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", "RIGHT_ORGANIZATION_ALL", "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", "RIGHT_ALL" ] } @@ -678715,6 +703794,23 @@ "type": "string" } } + }, + "tutorials": { + "type": "object", + "properties": { + "seen": { + "type": "array", + "items": { + "description": "Tutorial is a set of possible tutorials in the Console.", + "type": "string", + "default": "TUTORIAL_UNKNOWN", + "enum": [ + "TUTORIAL_UNKNOWN", + "TUTORIAL_LIVE_DATA_SPLIT_VIEW" + ] + } + } + } } } }, @@ -678888,6 +703984,23 @@ "type": "string" } } + }, + "tutorials": { + "type": "object", + "properties": { + "seen": { + "type": "array", + "items": { + "description": "Tutorial is a set of possible tutorials in the Console.", + "type": "string", + "default": "TUTORIAL_UNKNOWN", + "enum": [ + "TUTORIAL_UNKNOWN", + "TUTORIAL_LIVE_DATA_SPLIT_VIEW" + ] + } + } + } } } }, @@ -678943,6 +704056,34 @@ "description": "A description for the user. This information is public and can be seen by any authenticated user in the network.", "type": "string" }, + "email_notification_preferences": { + "description": "EmailNotificationPreferences is the message that defines the types of notifications for which the user wants to receive an email.", + "type": "object", + "properties": { + "types": { + "type": "array", + "items": { + "type": "string", + "default": "UNKNOWN", + "enum": [ + "UNKNOWN", + "API_KEY_CREATED", + "API_KEY_CHANGED", + "CLIENT_REQUESTED", + "COLLABORATOR_CHANGED", + "ENTITY_STATE_CHANGED", + "INVITATION", + "LOGIN_TOKEN", + "PASSWORD_CHANGED", + "TEMPORARY_PASSWORD", + "USER_REQUESTED", + "VALIDATE", + "SUPPORT_ACCESS_REQUESTED" + ] + } + } + } + }, "gateway_limit": { "description": "The maximum number of gateways of the user.\nThis field can only be modified by admins.", "type": "string", @@ -679042,6 +704183,109 @@ "type": "string", "format": "date-time" }, + "universal_rights": { + "description": "Universal rights are capable of restricting the user's interactions with the API, be it an admin or not.", + "type": "array", + "items": { + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "type": "string", + "default": "right_invalid", + "enum": [ + "right_invalid", + "RIGHT_USER_INFO", + "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", + "RIGHT_USER_SETTINGS_API_KEYS", + "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", + "RIGHT_USER_AUTHORIZED_CLIENTS", + "RIGHT_USER_APPLICATIONS_LIST", + "RIGHT_USER_APPLICATIONS_CREATE", + "RIGHT_USER_GATEWAYS_LIST", + "RIGHT_USER_GATEWAYS_CREATE", + "RIGHT_USER_CLIENTS_LIST", + "RIGHT_USER_CLIENTS_CREATE", + "RIGHT_USER_ORGANIZATIONS_LIST", + "RIGHT_USER_ORGANIZATIONS_CREATE", + "RIGHT_USER_NOTIFICATIONS_READ", + "RIGHT_USER_ALL", + "RIGHT_APPLICATION_INFO", + "RIGHT_APPLICATION_SETTINGS_BASIC", + "RIGHT_APPLICATION_SETTINGS_API_KEYS", + "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", + "RIGHT_APPLICATION_SETTINGS_PACKAGES", + "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", + "RIGHT_APPLICATION_DEVICES_READ", + "RIGHT_APPLICATION_DEVICES_WRITE", + "RIGHT_APPLICATION_DEVICES_READ_KEYS", + "RIGHT_APPLICATION_DEVICES_WRITE_KEYS", + "RIGHT_APPLICATION_TRAFFIC_READ", + "RIGHT_APPLICATION_TRAFFIC_UP_WRITE", + "RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE", + "RIGHT_APPLICATION_LINK", + "RIGHT_APPLICATION_ALL", + "RIGHT_CLIENT_ALL", + "RIGHT_CLIENT_INFO", + "RIGHT_CLIENT_SETTINGS_BASIC", + "RIGHT_CLIENT_SETTINGS_COLLABORATORS", + "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", + "RIGHT_GATEWAY_INFO", + "RIGHT_GATEWAY_SETTINGS_BASIC", + "RIGHT_GATEWAY_SETTINGS_API_KEYS", + "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", + "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", + "RIGHT_GATEWAY_TRAFFIC_READ", + "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", + "RIGHT_GATEWAY_LINK", + "RIGHT_GATEWAY_STATUS_READ", + "RIGHT_GATEWAY_LOCATION_READ", + "RIGHT_GATEWAY_WRITE_SECRETS", + "RIGHT_GATEWAY_READ_SECRETS", + "RIGHT_GATEWAY_ALL", + "RIGHT_ORGANIZATION_INFO", + "RIGHT_ORGANIZATION_SETTINGS_BASIC", + "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", + "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", + "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", + "RIGHT_ORGANIZATION_APPLICATIONS_LIST", + "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", + "RIGHT_ORGANIZATION_GATEWAYS_LIST", + "RIGHT_ORGANIZATION_GATEWAYS_CREATE", + "RIGHT_ORGANIZATION_CLIENTS_LIST", + "RIGHT_ORGANIZATION_CLIENTS_CREATE", + "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", + "RIGHT_ORGANIZATION_ALL", + "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", + "RIGHT_ALL" + ] + } + }, "updated_at": { "description": "When the user was last updated. This information is public and can be seen by any authenticated user in the network.", "type": "string", @@ -679288,6 +704532,23 @@ "type": "string" } } + }, + "tutorials": { + "type": "object", + "properties": { + "seen": { + "type": "array", + "items": { + "description": "Tutorial is a set of possible tutorials in the Console.", + "type": "string", + "default": "TUTORIAL_UNKNOWN", + "enum": [ + "TUTORIAL_UNKNOWN", + "TUTORIAL_LIVE_DATA_SPLIT_VIEW" + ] + } + } + } } } }, @@ -679343,6 +704604,34 @@ "description": "A description for the user. This information is public and can be seen by any authenticated user in the network.", "type": "string" }, + "email_notification_preferences": { + "description": "EmailNotificationPreferences is the message that defines the types of notifications for which the user wants to receive an email.", + "type": "object", + "properties": { + "types": { + "type": "array", + "items": { + "type": "string", + "default": "UNKNOWN", + "enum": [ + "UNKNOWN", + "API_KEY_CREATED", + "API_KEY_CHANGED", + "CLIENT_REQUESTED", + "COLLABORATOR_CHANGED", + "ENTITY_STATE_CHANGED", + "INVITATION", + "LOGIN_TOKEN", + "PASSWORD_CHANGED", + "TEMPORARY_PASSWORD", + "USER_REQUESTED", + "VALIDATE", + "SUPPORT_ACCESS_REQUESTED" + ] + } + } + } + }, "gateway_limit": { "description": "The maximum number of gateways of the user.\nThis field can only be modified by admins.", "type": "string", @@ -679444,6 +704733,109 @@ "type": "string", "format": "date-time" }, + "universal_rights": { + "description": "Universal rights are capable of restricting the user's interactions with the API, be it an admin or not.", + "type": "array", + "items": { + "description": "Right is the enum that defines all the different rights to do something in the network.\n\n - RIGHT_USER_INFO: The right to view user information.\n - RIGHT_USER_SETTINGS_BASIC: The right to edit basic user settings.\n - RIGHT_USER_LIST: The right to list users accounts.\n - RIGHT_USER_CREATE: The right to create an user account.\n - RIGHT_USER_SETTINGS_API_KEYS: The right to view and edit user API keys.\n - RIGHT_USER_DELETE: The right to delete user account.\n - RIGHT_USER_PURGE: The right to purge user account.\n - RIGHT_USER_AUTHORIZED_CLIENTS: The right to view and edit authorized OAuth clients of the user.\n - RIGHT_USER_APPLICATIONS_LIST: The right to list applications the user is a collaborator of.\n - RIGHT_USER_APPLICATIONS_CREATE: The right to create an application under the user account.\n - RIGHT_USER_GATEWAYS_LIST: The right to list gateways the user is a collaborator of.\n - RIGHT_USER_GATEWAYS_CREATE: The right to create a gateway under the account of the user.\n - RIGHT_USER_CLIENTS_LIST: The right to list OAuth clients the user is a collaborator of.\n - RIGHT_USER_CLIENTS_CREATE: The right to create an OAuth client under the account of the user.\n - RIGHT_USER_ORGANIZATIONS_LIST: The right to list organizations the user is a member of.\n - RIGHT_USER_ORGANIZATIONS_CREATE: The right to create an organization under the user account.\n - RIGHT_USER_NOTIFICATIONS_READ: The right to read notifications sent to the user.\n - RIGHT_USER_ALL: The pseudo-right for all (current and future) user rights.\n - RIGHT_APPLICATION_INFO: The right to view application information.\n - RIGHT_APPLICATION_SETTINGS_BASIC: The right to edit basic application settings.\n - RIGHT_APPLICATION_SETTINGS_API_KEYS: The right to view and edit application API keys.\n - RIGHT_APPLICATION_SETTINGS_COLLABORATORS: The right to view and edit application collaborators.\n - RIGHT_APPLICATION_SETTINGS_PACKAGES: The right to view and edit application packages and associations.\n - RIGHT_APPLICATION_DELETE: The right to delete application.\n - RIGHT_APPLICATION_PURGE: The right to purge application.\n - RIGHT_APPLICATION_DEVICES_READ: The right to view devices in application.\n - RIGHT_APPLICATION_DEVICES_WRITE: The right to create devices in application.\n - RIGHT_APPLICATION_DEVICES_READ_KEYS: The right to view device keys in application.\nNote that keys may not be stored in a way that supports viewing them.\n - RIGHT_APPLICATION_DEVICES_WRITE_KEYS: The right to edit device keys in application.\n - RIGHT_APPLICATION_TRAFFIC_READ: The right to read application traffic (uplink and downlink).\n - RIGHT_APPLICATION_TRAFFIC_UP_WRITE: The right to write uplink application traffic.\n - RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE: The right to write downlink application traffic.\n - RIGHT_APPLICATION_LINK: The right to link as Application to a Network Server for traffic exchange,\ni.e. read uplink and write downlink (API keys only).\nThis right is typically only given to an Application Server.\nThis right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,\nand RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.\n - RIGHT_APPLICATION_ALL: The pseudo-right for all (current and future) application rights.\n - RIGHT_CLIENT_ALL: The pseudo-right for all (current and future) OAuth client rights.\n - RIGHT_CLIENT_INFO: The right to read client information.\n - RIGHT_CLIENT_SETTINGS_BASIC: The right to edit basic client settings.\n - RIGHT_CLIENT_SETTINGS_COLLABORATORS: The right to view and edit client collaborators.\n - RIGHT_CLIENT_DELETE: The right to delete a client.\n - RIGHT_CLIENT_PURGE: The right to purge a client.\n - RIGHT_GATEWAY_INFO: The right to view gateway information.\n - RIGHT_GATEWAY_SETTINGS_BASIC: The right to edit basic gateway settings.\n - RIGHT_GATEWAY_SETTINGS_API_KEYS: The right to view and edit gateway API keys.\n - RIGHT_GATEWAY_SETTINGS_COLLABORATORS: The right to view and edit gateway collaborators.\n - RIGHT_GATEWAY_DELETE: The right to delete gateway.\n - RIGHT_GATEWAY_PURGE: The right to purge gateway.\n - RIGHT_GATEWAY_TRAFFIC_READ: The right to read gateway traffic.\n - RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE: The right to write downlink gateway traffic.\n - RIGHT_GATEWAY_LINK: The right to link as Gateway to a Gateway Server for traffic exchange,\ni.e. write uplink and read downlink (API keys only)\nThis right is typically only given to a gateway.\nThis right implies RIGHT_GATEWAY_INFO.\n - RIGHT_GATEWAY_STATUS_READ: The right to view gateway status.\n - RIGHT_GATEWAY_LOCATION_READ: The right to view view gateway location.\n - RIGHT_GATEWAY_WRITE_SECRETS: The right to store secrets associated with this gateway.\n - RIGHT_GATEWAY_READ_SECRETS: The right to retrieve secrets associated with this gateway.\n - RIGHT_GATEWAY_ALL: The pseudo-right for all (current and future) gateway rights.\n - RIGHT_ORGANIZATION_INFO: The right to view organization information.\n - RIGHT_ORGANIZATION_SETTINGS_BASIC: The right to edit basic organization settings.\n - RIGHT_ORGANIZATION_SETTINGS_API_KEYS: The right to view and edit organization API keys.\n - RIGHT_ORGANIZATION_SETTINGS_MEMBERS: The right to view and edit organization members.\n - RIGHT_ORGANIZATION_DELETE: The right to delete organization.\n - RIGHT_ORGANIZATION_PURGE: The right to purge organization.\n - RIGHT_ORGANIZATION_APPLICATIONS_LIST: The right to list the applications the organization is a collaborator of.\n - RIGHT_ORGANIZATION_APPLICATIONS_CREATE: The right to create an application under the organization.\n - RIGHT_ORGANIZATION_GATEWAYS_LIST: The right to list the gateways the organization is a collaborator of.\n - RIGHT_ORGANIZATION_GATEWAYS_CREATE: The right to create a gateway under the organization.\n - RIGHT_ORGANIZATION_CLIENTS_LIST: The right to list the OAuth clients the organization is a collaborator of.\n - RIGHT_ORGANIZATION_CLIENTS_CREATE: The right to create an OAuth client under the organization.\n - RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR: The right to add the organization as a collaborator on an existing entity.\n - RIGHT_ORGANIZATION_ALL: The pseudo-right for all (current and future) organization rights.\n - RIGHT_SEND_INVITES: The right to send invites to new users.\nNote that this is not prefixed with \"USER_\"; it is not a right on the user entity.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE: The right to create an alert notification profile.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_INFO: The right to view an alert notification profile information.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_LIST: The right to list the alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE: The right to update an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE: The right to delete an alert notification profiles.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE: The right to create an alert notification receiver.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO: The right to view an alert notification receiver information.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST: The right to list the alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE: The right to update an alert notification receivers.\n - RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE: The right to delete an alert notification receivers.\n - RIGHT_AUTHENTICATION_PROVIDER_CREATE: The right to create an authentication provider.\n - RIGHT_AUTHENTICATION_PROVIDER_INFO: The right to view an authentication provider information.\n - RIGHT_AUTHENTICATION_PROVIDER_LIST: The right to list the authentication providers\n - RIGHT_AUTHENTICATION_PROVIDER_UPDATE: The right to update an authentication providers.\n - RIGHT_AUTHENTICATION_PROVIDER_DELETE: The right to delete an authentication providers.\n - RIGHT_EXTERNAL_USER_CREATE: The right to create an external user.\n - RIGHT_EXTERNAL_USER_INFO: The right to view an external user's information.\n - RIGHT_EXTERNAL_USER_DELETE: The right to delete an external user.\n - RIGHT_PACKET_BROKER_AGENT_READ: The right to read any information related to the PBA.\n - RIGHT_PACKET_BROKER_AGENT_WRITE: The right to perform operations in the PBA.\n - RIGHT_TENANT_CONFIGURATION_UPDATE: The right to update a tenant's configuration.\n - RIGHT_ALL: The pseudo-right for all (current and future) possible rights.", + "type": "string", + "default": "right_invalid", + "enum": [ + "right_invalid", + "RIGHT_USER_INFO", + "RIGHT_USER_SETTINGS_BASIC", + "RIGHT_USER_LIST", + "RIGHT_USER_CREATE", + "RIGHT_USER_SETTINGS_API_KEYS", + "RIGHT_USER_DELETE", + "RIGHT_USER_PURGE", + "RIGHT_USER_AUTHORIZED_CLIENTS", + "RIGHT_USER_APPLICATIONS_LIST", + "RIGHT_USER_APPLICATIONS_CREATE", + "RIGHT_USER_GATEWAYS_LIST", + "RIGHT_USER_GATEWAYS_CREATE", + "RIGHT_USER_CLIENTS_LIST", + "RIGHT_USER_CLIENTS_CREATE", + "RIGHT_USER_ORGANIZATIONS_LIST", + "RIGHT_USER_ORGANIZATIONS_CREATE", + "RIGHT_USER_NOTIFICATIONS_READ", + "RIGHT_USER_ALL", + "RIGHT_APPLICATION_INFO", + "RIGHT_APPLICATION_SETTINGS_BASIC", + "RIGHT_APPLICATION_SETTINGS_API_KEYS", + "RIGHT_APPLICATION_SETTINGS_COLLABORATORS", + "RIGHT_APPLICATION_SETTINGS_PACKAGES", + "RIGHT_APPLICATION_DELETE", + "RIGHT_APPLICATION_PURGE", + "RIGHT_APPLICATION_DEVICES_READ", + "RIGHT_APPLICATION_DEVICES_WRITE", + "RIGHT_APPLICATION_DEVICES_READ_KEYS", + "RIGHT_APPLICATION_DEVICES_WRITE_KEYS", + "RIGHT_APPLICATION_TRAFFIC_READ", + "RIGHT_APPLICATION_TRAFFIC_UP_WRITE", + "RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE", + "RIGHT_APPLICATION_LINK", + "RIGHT_APPLICATION_ALL", + "RIGHT_CLIENT_ALL", + "RIGHT_CLIENT_INFO", + "RIGHT_CLIENT_SETTINGS_BASIC", + "RIGHT_CLIENT_SETTINGS_COLLABORATORS", + "RIGHT_CLIENT_DELETE", + "RIGHT_CLIENT_PURGE", + "RIGHT_GATEWAY_INFO", + "RIGHT_GATEWAY_SETTINGS_BASIC", + "RIGHT_GATEWAY_SETTINGS_API_KEYS", + "RIGHT_GATEWAY_SETTINGS_COLLABORATORS", + "RIGHT_GATEWAY_DELETE", + "RIGHT_GATEWAY_PURGE", + "RIGHT_GATEWAY_TRAFFIC_READ", + "RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE", + "RIGHT_GATEWAY_LINK", + "RIGHT_GATEWAY_STATUS_READ", + "RIGHT_GATEWAY_LOCATION_READ", + "RIGHT_GATEWAY_WRITE_SECRETS", + "RIGHT_GATEWAY_READ_SECRETS", + "RIGHT_GATEWAY_ALL", + "RIGHT_ORGANIZATION_INFO", + "RIGHT_ORGANIZATION_SETTINGS_BASIC", + "RIGHT_ORGANIZATION_SETTINGS_API_KEYS", + "RIGHT_ORGANIZATION_SETTINGS_MEMBERS", + "RIGHT_ORGANIZATION_DELETE", + "RIGHT_ORGANIZATION_PURGE", + "RIGHT_ORGANIZATION_APPLICATIONS_LIST", + "RIGHT_ORGANIZATION_APPLICATIONS_CREATE", + "RIGHT_ORGANIZATION_GATEWAYS_LIST", + "RIGHT_ORGANIZATION_GATEWAYS_CREATE", + "RIGHT_ORGANIZATION_CLIENTS_LIST", + "RIGHT_ORGANIZATION_CLIENTS_CREATE", + "RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR", + "RIGHT_ORGANIZATION_ALL", + "RIGHT_SEND_INVITES", + "RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_INFO", + "RIGHT_ALERT_NOTIFICATION_PROFILE_LIST", + "RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE", + "RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE", + "RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE", + "RIGHT_AUTHENTICATION_PROVIDER_CREATE", + "RIGHT_AUTHENTICATION_PROVIDER_INFO", + "RIGHT_AUTHENTICATION_PROVIDER_LIST", + "RIGHT_AUTHENTICATION_PROVIDER_UPDATE", + "RIGHT_AUTHENTICATION_PROVIDER_DELETE", + "RIGHT_EXTERNAL_USER_CREATE", + "RIGHT_EXTERNAL_USER_INFO", + "RIGHT_EXTERNAL_USER_DELETE", + "RIGHT_PACKET_BROKER_AGENT_READ", + "RIGHT_PACKET_BROKER_AGENT_WRITE", + "RIGHT_TENANT_CONFIGURATION_UPDATE", + "RIGHT_ALL" + ] + } + }, "updated_at": { "description": "When the user was last updated. This information is public and can be seen by any authenticated user in the network.", "type": "string", @@ -679724,6 +705116,10 @@ "description": "Manage batches of end devices on The Things Stack Network Server.", "name": "NsEndDeviceBatchRegistry" }, + { + "description": "Manage MAC settings profiles on The Things Stack Network Server.", + "name": "NsMACSettingsProfileRegistry" + }, { "description": "Manage configuration of LoRaWAN® relay devices.", "name": "NsRelayConfigurationService" diff --git a/doc/data/commands/ttn-lw-cli.json b/doc/data/commands/ttn-lw-cli.json index 79c0b06a7c..50516df79f 100644 --- a/doc/data/commands/ttn-lw-cli.json +++ b/doc/data/commands/ttn-lw-cli.json @@ -1035,6 +1035,10 @@ "short": "Search for tenants", "path": "ttn-lw-cli tenants search" }, + "support-login-token": { + "short": "Generate a login token associated with the unique 'support' user", + "path": "ttn-lw-cli tenants support-login-token" + }, "update": { "short": "Update a tenant", "path": "ttn-lw-cli tenants update"