SMsmartthings
SmartApps

Update an App's Signature Type

Changed on

Updates the signature type of an App. Signature options:

  • APP_RSA - Legacy signing mechanism comprised of a public / private key generated for an App during registration. This mechanism requires an App to download the public key and deploy along side their integration to verify the signature in the authorization header.
  • ST_PADLOCK - App callbacks are signed with a SmartThings certificate which is publicly available at https://key.smartthings.com. App's authorize callbacks by fetching the certificate over HTTPS and using it to validate the signature in the authorization header.

When upgrading an App from APP_RSA to ST_PADLOCK, it is recommended to implement both verification methods. This will provide the ability to seamlessly switch between mechanisms if a rollback is needed.

put/smartapps/{appNameOrId}/signature-type

Request

Path parameters

appNameOrIdstring required

The appName or appId field of an app.

Headers

Authorizationstring string required

OAuth token

Request body

signatureType'APP_RSA' | 'ST_PADLOCK'

The http signature type used for authorizing event delivery. APP_RSA generates an RSA key pair that will be used to verify requests from SmartThings. ST_PADLOCK requires verifcation through SmartThings public certificate.

Example request

{
  "signatureType": "ST_PADLOCK"
}

Response

App signature type will be updated asynchronously. This change take effect within a few minutes.

UpdateSignatureTypeResponse required

An empty object response.

Example response

{}

Changes