tb_ce_client.models.ApiKey
| Name | Type | Description | Notes |
|---|---|---|---|
| id | ApiKeyId | JSON object with the API Key Id. Specify this field to update the API Key. Referencing non-existing API Key Id will cause error. Omit this field to create new API Key. | [optional] |
| created_time | int | Entity creation timestamp in milliseconds since Unix epoch | [optional] [readonly] |
| tenant_id | TenantId | JSON object with Tenant Id. Tenant Id of the API key cannot be changed. | [optional] [readonly] |
| user_id | UserId | JSON object with User Id. User Id of the API key cannot be changed. | [optional] |
| expiration_time | int | Expiration time of the API key. | [optional] |
| description | str | API Key description. | |
| enabled | bool | Enabled/disabled API key. | [optional] |
| value | str | API key value | |
| expired | bool | Indicates if the API key is expired based on current time. Returns false if expirationTime is 0 (no expiry). | [optional] [readonly] |
EntityId types (
AdminSettingsId,AiModelId,AlarmId,ApiKeyId,ApiUsageStateId,AssetId,AssetProfileId,CalculatedFieldId,CustomerId,DashboardId,DeviceId,DeviceProfileId,DomainId,EdgeId,EntityViewId,JobId,MobileAppBundleId,MobileAppId,NotificationId,NotificationRequestId,NotificationRuleId,NotificationTargetId,NotificationTemplateId,OAuth2ClientId,OtaPackageId,QueueId,QueueStatsId,RpcId,RuleChainId,RuleNodeId,TbResourceId,TenantId,TenantProfileId,UserId,WidgetTypeId,WidgetsBundleId, etc.):{entity_type: EntityType, id: UUID}— all EntityId subtypes share this structure.
TENANT | CUSTOMER | USER | DASHBOARD | ASSET | DEVICE | ALARM | RULE_CHAIN | RULE_NODE | ENTITY_VIEW | … (36 values total)
- Package:
tb_ce_client.models - Attribute access:
obj.id,obj.name, etc. - Serialize:
obj.model_dump()orobj.model_dump(by_alias=True)for camelCase JSON - Deserialize:
ApiKey.model_validate(data)orApiKey.model_validate_json(json_str) - None fields: Optional attributes default to
None; accessing them never raises exceptions