omni::telemetry::kTelemetryAuthTokenUrlSettingLeaf

Defined in omni/structuredlog/Telemetry.h

constexpr const char *const omni::telemetry::kTelemetryAuthTokenUrlSettingLeaf = "authTokenUrl"

This setting is an optional member of the kTransmitterSetting object.

This specifies the URL to download the authentication token from. This option will be ignored if kTelemetryAuthenticateSettingLeaf is false. A file will be expected to be downloaded from this URL. The downloaded file is expected to be JSON formatted and is expected to contain the authentication token in the format that the authentication server expects. The name of the data property in the file that contains the actual token to be sent with each message is specified in kTelemetryAuthTokenKeyNameSettingLeaf. The data property in the file that contains the token’s expiry date is specified in kTelemetryAuthTokenExpiryNameSettingLeaf. Alternatively, this setting may also point to a file on disk (either with the ‘file://’ protocol or by naming the file directly). If a file on disk is named, it is assumed to either be JSON formatted and also contain the token data and expiry under the same key names as given with kTelemetryAuthTokenKeyNameSettingLeaf and kTelemetryAuthTokenExpiryNameSettingLeaf, or it will be a file whose entire contents will be the token itself. The latter mode is only used when the kTelemetryAuthTokenKeyNameSettingLeaf setting is an empty string. By default, the URL for the Omniverse Launcher’s authentication web API will be used.