Schemas

The secret to authenticate with

The organization name to authenticate against

The token to use for authentication, should be passed in the Authorization header as a Bearer token.

The number of seconds the token is valid for.

The total number of certificates matching the query.

The cveId field represents CVE identifier (if available).

The description field provides a detailed description of the vulnerability.

The reportDate field indicates the date when the vulnerability was reported.

The severity field indicates the severity of the vulnerability.

The reportLink field provides a link to the vulnerability report.

The unique identifier of the device, generated by SecuriThings and will identify the device in the system.

The name field represents the user-assigned device name as displayed in the management system.

The manufacturer of the device.

The model of the device.

the current firmware version that the device is running.

The type of device, such as camera, access control panel, intercom, or other classifications.

Nested object providing compliance-related details.

Nested object providing network-related details.

The current operational status of the device (e.g., "online" or "offline").

The last known active time of the device in ISO 8601 format.

The status of each probe available.

Specifies the discovery source and the integration methods for the device.

Specifies the site or geolocation associated with the device, indicating the physical or logical location to which it is connected.

The date and time the device was onboarded, in ISO 8601 format.

Whether the device is in maintenance mode.

The recording status of the device.

The storage server the device is associated with.

Whether the device no longer exists in the management platform.

The unique identifier of the device, generated by SecuriThings and will identify the device in the system.

Specifies the discovery source and the integration methods for the device.

The storage server the device is associated with.

The name of the device.

The type of device, such as camera, access control panel, intercom, or other classifications.

The IP address of the device.

The manufacturer of the device.

The date and time the device was discovered, in ISO 8601 format.

The onboarding status of the device.

The unique identifier.

The name assigned to the site, provided by the user.

A brief explanation of the site's purpose or significance.

The geographic coordinates of the site.

The status of the site, can be online, offline, partial, or unknown.

The unique identifier.

The name of the device source, as define by the user.

The type of the device source, indicating the integration or system.

The version of the device source as defined by the end user in the system.

The step id.

The ID of the device task this step belongs to.

The position of the step in the task sequence.

The name of the step.

The status of the step.

The message returned when the step ran.

The HTTP status code returned when the step ran.

The date and time the step run status was last updated, in ISO 8601 format.

The message returned during rollback, if any.

The HTTP status code returned during rollback, if any.

The date and time the rollback status was last updated, in ISO 8601 format.

The date and time the step was created, in ISO 8601 format.

The date and time the step was last updated, in ISO 8601 format.

The version of the step definition.

The device task id.

The ID of the task this device task belongs to.

The type of task.

The date and time the task was created, in ISO 8601 format.

The status of the current step. May be null.

The host of the device.

The ID of the device.

The model of the device.

The name of the device.

The result of the task. null while the task is not yet completed.

The overall status of the task.

The steps performed as part of the task.

If true, a password is auto-generated using the password policy fields. If false, targetPassword must be provided.

If true, the password is changed for all users matching the specified userRoles. If false, targetUsers must be provided.

Password expiry period in days. Allowed values are 30, 45, 60, 90, 180, 365, or null. Use null for unlimited time.

Whether to enforce HTTPS during password rotation.

Required and only valid when autoGeneratePassword is true. Length of the generated password, between 4 and 64 characters.

Required and only valid when autoGeneratePassword is true. Include uppercase letters in the generated password.

Required and only valid when autoGeneratePassword is true. Include lowercase letters in the generated password.

Required and only valid when autoGeneratePassword is true. Include numbers in the generated password.

Required and only valid when autoGeneratePassword is true. Include symbols in the generated password.

Required and only valid when autoGeneratePassword is false. The specific password to set on the device. Up to 64 characters.

Required and only valid when changePasswordByRole is true. The user roles to target for password rotation.

Required and only valid when changePasswordByRole is false. The specific usernames to target for password rotation.

Enable recovery mode.

Update Genetec to use 'Custom Template' instead of 'Default Credentials'. Note: This action is required once when performing password rotation for a device through the SecuriThings platform for the first time.

Only valid when changePasswordByRole is true. List of usernames to ignore during password rotation.

Who generates the certificate.

The certificate common name.

ISO 3166-1 alpha-2 country code (e.g. US, GB).

Validate secure communication with the device before rotating. Set to false if no certificate is installed on the device.

Validate the device's connection to the management platform.

The key size for the generated certificate. Required and only valid when generateBy is platform.

Include DNS as a Subject Alternative Name. Defaults to false. Only valid when generateBy is platform.

Include IP as a Subject Alternative Name. Defaults to false. Only valid when generateBy is platform.

Contact email. Only valid when generateBy is platform.

State or province.

City or locality.

Organization name.

Department or organizational unit.