Defines the object schema located at components.schemas.apps.secret in the specification.
Secret Store is an API that allows Stripe Apps developers to securely persist secrets for use by UI Extensions and app backends.
The primary resource in Secret Store is a `secret`. Other apps can't view secrets created by an app. Additionally, secrets are scoped to provide further permission control.
All Dashboard users and the app backend share `account` scoped secrets. Use the `account` scope for secrets that don't change per-user, like a third-party API key.
A `user` scoped secret is accessible by the app backend and one specific Dashboard user. Use the `user` scope for per-user secrets like per-user OAuth tokens, where different users might have different permissions.
Related guide: Store data between page reloads.
Constructors
Apps'secretapps'secretCreated :: Intcreated: Time at which the object was created. Measured in seconds since the Unix epoch.
apps'secretDeleted :: Maybe Booldeleted: If true, indicates that this secret has been deleted
apps'secretId :: Textid: Unique identifier for the object.
Constraints:
Maximum length of 5000
apps'secretLivemode :: Boollivemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
apps'secretName :: Textname: A name for the secret that's unique within the scope.
Constraints:
Maximum length of 5000
apps'secretPayload :: Maybe (Nullable Text)payload: The plaintext secret value to be stored.
Constraints:
Maximum length of 5000
apps'secretScope :: SecretServiceResourceScopescope:
Instances4Eq, Show, FromJSON, ToJSON
Eq Apps'secretDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Apps_SecretShow Apps'secretDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Apps_SecretFromJSON Apps'secretDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Apps_SecretToJSON Apps'secretDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Apps_Secret