SharedSecret Object

Includes encrypted information about an app's Shared Secret value, in JSON format, if the Shared Secret is stored on the platform. Not valid for apps that have a user-defined app identity referencing an external identity domain.

Note: If the app has a user-defined App Identity that includes a domain, the platform does not collect, regenerate, return, or display the Shared Secret value. Instead, the user manages the app's Shared Secret in the external identity domain, which must be a valid domain set up in the platform. The platform takes the Shared Secret value that the user provides and validates it with the external identity domain. In these scenarios, this operation cannot retrieve the app's shared secret.

This object is used by the following operations:

The properties included in the SharedSecret object are listed below.

Property Type Description
SharedSecret string The shared secret value for the app, in plain text. The plain text value is returned if the "return plain text" setting is enabled for the platform.
EncryptedSharedSecret string

The shared secret value for the app, encrypted. The encrypted value is returned if both these conditions apply:

  • The "return plain text" setting is disabled for the platform.
  • A CSR is available for the app, so that the Shared Secret can be encrypted with the app's public key and can be decrypted by the app developer using the app's private key.
Availability string Indicates whether a shared secret has been assigned to the app (always true). If the shared secret is returned in plain text, the Assigned field is not returned (for backwards compatibility).