NoTourV1 Trait
Information about the device's configuration settings to read Schlage ENGAGE No Tour credentials and the actions to set them. Trait Type: Standard
Action Mutations
Note: See Overview: Device Action Lifecycle for more information on action flows.
NoTourV1SetNoTourState
Enables or disables the No Tour capability for enabled devices.
Mutation Inputs
deviceId | UUID of the device to which the mutation should apply | ID! | false |
noTourState | The enabled/disabled state of the device's No Tour capability | enum (ENABLED or DISABLED)! | false |
GQL Examples
Request Example
mutation NoTourV1SetNoTourState {
NoTourV1SetNoTourState(
deviceId: "9a8f6104-6c50-476e-90ee-16b9a2dafc8d",
traitActionArgs: { noTourState: "ENABLED" }
) {
deviceId
actionId
}
}Response Example
{
"data": {
"NoTourV1SetNoTourState": {
"actionId": "7eb3629a-a1c3-49f0-89b6-2831d500ac68",
"deviceId": "9a8f6104-6c50-476e-90ee-16b9a2dafc8d"
}
}
}NoTourV1ConfigNoTour
Sets the No Tour configuration settings of the enabled device.
Action Pre-Requisites
Once the following have been met, the client may submit this action according to the linked action lifecycle flow.
- Client MUST have a site set up in the Schlage ENGAGE system that supports No Tour.
- Client MUST obtain the key of the Schlage ENGAGE No Tour site to which the device should be associated.
- Client MUST generate a HEX string containing the SHA-256 hash of the Schlage ENGAGE
siteKeyvalue for input into the mutation. - Client MUST encrypt the Schlage ENGAGE
siteKeyvalue for input into the mutation according to the encryption requirements laid out below. - Client MUST generate a
noTourDoorIdand correlate it to the deviceId. The ID must be an integer from 0 to 65535 and must be unique to each device correlated to the Schlage ENGAGEsiteKey(in YP or ENGAGE systems).
Site Key Encryption Requirements
- Encrypt using the following public key:
-----BEGIN PUBLIC KEY-----
MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEA5A1AVahduKCiCBrOgEhk
ksTYf/zgDiv2CTsP8rbp1/8PWzVbA1jC3BHQkDwq/fm3x5ld5eIy52b0dG0sTyL5
G96chBiYtNXnqBlO9ZcNHpPu7Z0GzRKCBHUlV1xqBH8S22m70CMVQVb5mZ8DY1ZO
Q5DBbUx5IZVDqzEhku7ISv7u2XeRiGEzlTEdr5FEwMmZWGLAAj+B5bQeqH8Gumfc
SVmfTJ7rI5WpbkhAUada2tRGZcPJVOIsJMk27yCv4rBXvGkVl8dyeuypSckkh2Em
2KXZug77BV/u2VjbvnFhNK7CBzwq6C0GwfZtpqgiyPy3HFqPGf4+b3uGbdQkIBEr
heAKMRi56R03lFGStA1HCiIQ6guMI1aPOT/pBDYSpGi6wrSOf/+fsfKXrnZHyF/D
OvWa88cSu+OsvV560b2hWuqINB1LwbWWomHGYxRq3h+h/4vgMReQnpLb9J+4brY8
VoiqooRwKLYeIfCJNcjCC3pa3shpFL+Ql46TqoKqljH/Jxh/LmHOk4x6ee/pkYNQ
3lLV1JF0G+LAnvskYOtBl0okwLqlyekZqOrw8FNGz63S97D/FfcFlK+1zwUwXNAY
nsnL32PP6tYNjcVSkhUj03RjKSiBiEwLRzgTB9ePlqT5n144dwK5y0QRbCIlVXwI
YbVGkNKy1OaBJEUVW85Rzc8CAwEAAQ==
-----END PUBLIC KEY------ Algorithm: RSA with 4096‑bit modulus (RSA‑4096).
- Padding: RSA‑OAEP with SHA‑256 and MGF1 using SHA‑256. Label = None.
- Input encoding: plaintext UTF‑8 bytes of the exact value to be encrypted (no padding, case changes, or newline).
- Output format: ciphertext bytes encoded as lowercase hex, no 0x prefix, no spaces/newlines. With RSA‑4096 the ciphertext is 512 bytes → 1024 hex characters.
Mutation Inputs
noTourDoorId | 2-byte No Tour identifier associated with the device. Must be unique for all devices within a given | Int (0 to 65535)! | false |
noTourGroupIds | Array of integers used to assign the device to one or more groups of potentially many devices. When included in the request, the input must have an array containing 1 to 16 integers, each integer may be from 0 to 65535. | Array | true |
noTourEncryptedSiteKey | Object containing the encrypted value and SHA-256 hash of the Schlage ENGAGE siteKey. | NoTourEncryptedSiteKeyObject! | false |
NoTourEncryptedSiteKeyObject Fields
encryptedValue | The HEX string output from encrypting the Schlage ENGAGE | HEX String (length = 1024 characters)! | false |
originalDataHash | The HEX string output from encoding a SHA-256 hash of the Schlage ENGAGE | HEX String (length = 64 characters)! | false |
GQL Examples
Request Example
mutation NoTourV1ConfigNoTour {
NoTourV1ConfigNoTour(
deviceId: "9a8f6104-6c50-476e-90ee-16b9a2dafc8d"
traitActionArgs: {
noTourDoorId: 65535
noTourGroupIds: [0, 65535]
noTourEncryptedSiteKey: {
encryptedValue: "{{encryptedSiteKey}}"
originalDataHash: "{{SHA256Hash}}"
}
}
) {
deviceId
actionId
traitName
}
}Response Example
{
"data": {
"NoTourV1ConfigNoTour": {
"actionId": "7eb3629a-a1c3-49f0-89b6-2831d500ac68",
"deviceId": "9a8f6104-6c50-476e-90ee-16b9a2dafc8d"
}
}
}Reported States
Note: See Overview: Device Reported State for more information on reported state flows.
State Definitions
noTourDoorId State
Unique 2-byte identifier associated with the device. Must be unique for all devices within a given siteKey in both the YP and Schlage ENGAGE systems.
DataType: Integer
noTourGroupIds State
Array of 1 to 16 items. Each item indicates a unique ID that assigns the device to one or more No Tour groups.
DataType: Array of Integers
noTourActiveSector State
Sector of the credential to which No Tour data is written. For Schlage ENGAGE compatibility, this is always Sector 2.
DataType: String
noTourSha256HashSiteKey State
SHA‑256 hash of the decrypted siteKey value written to the device. This can be compared to the SHA‑256 hash of the original siteKey value to confirm that the value written to the device matches the correct siteKey.
DataType: String
noTourState State
The enabled/disabled state of the device's No Tour capability.
DataType: String
noTourRemainingCredentials State
The remaining number of No Tour credentials that may be written to the device.
DataType: Integer
Device State Query GQL Examples
Request Example
query Device {
device(deviceId: null) {
traits {
... on NoTourV1DeviceTrait {
name
state {
noTourDoorId {
reported {
value
}
}
noTourGroupIds {
reported {
value
}
}
noTourActiveSector {
reported {
value
}
}
noTourSha256HashSiteKey {
reported {
value
}
}
noTourState {
reported {
value
}
}
noTourRemainingCredentials {
reported {
value
}
}
}
}
}
}
}Response Example
{
"data": {
"device": {
"id": "9a8f6104-6c50-476e-90ee-16b9a2dafc8d",
"traits": [
{
"name": "NoTourV1",
"state": {
"noTourDoorId": {
"reported": {
"value": 65535
}
},
"noTourGroupIds": {
"reported": {
"value": [0, 65535]
}
},
"noTourActiveSector": {
"reported": {
"value": "SECTOR_2"
}
},
"noTourSha256HashSiteKey": {
"reported": {
"value": "{SHA256HashEncodedHexString}"
}
},
"noTourState": {
"reported": {
"value": "ENABLED"
}
},
"noTourRemainingCredentials": {
"reported": {
"value": 0
}
}
}
}
]
}
}
}What made this section unhelpful for you?
On this page
- NoTourV1 Trait