Class: Stripe::Apps::Secret
- Inherits:
-
Stripe::APIResource
- Object
- StripeObject
- Stripe::APIResource
- Stripe::Apps::Secret
- Extended by:
- Stripe::APIOperations::Create, Stripe::APIOperations::List
- Defined in:
- lib/stripe/resources/apps/secret.rb
Overview
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](stripe.com/docs/stripe-apps/store-auth-data-custom-objects)
Constant Summary collapse
- OBJECT_NAME =
"apps.secret"
Constants inherited from StripeObject
StripeObject::RESERVED_FIELD_NAMES
Instance Attribute Summary
Attributes inherited from Stripe::APIResource
Attributes inherited from StripeObject
Class Method Summary collapse
-
.create(params = {}, opts = {}) ⇒ Object
Create or replace a secret in the secret store.
-
.delete_where(params = {}, opts = {}) ⇒ Object
Deletes a secret from the secret store by name and scope.
-
.find(params = {}, opts = {}) ⇒ Object
Finds a secret in the secret store by name and scope.
-
.list(params = {}, opts = {}) ⇒ Object
List all secrets stored on the given scope.
- .object_name ⇒ Object
Methods included from Stripe::APIOperations::Create
Methods included from Stripe::APIOperations::List
Methods inherited from Stripe::APIResource
class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource
Methods included from Stripe::APIOperations::Request
Methods inherited from StripeObject
#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values
Constructor Details
This class inherits a constructor from Stripe::StripeObject
Dynamic Method Handling
This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject
Class Method Details
.create(params = {}, opts = {}) ⇒ Object
Create or replace a secret in the secret store.
25 26 27 |
# File 'lib/stripe/resources/apps/secret.rb', line 25 def self.create(params = {}, opts = {}) request_stripe_object(method: :post, path: "/v1/apps/secrets", params: params, opts: opts) end |
.delete_where(params = {}, opts = {}) ⇒ Object
Deletes a secret from the secret store by name and scope.
30 31 32 33 34 35 36 37 |
# File 'lib/stripe/resources/apps/secret.rb', line 30 def self.delete_where(params = {}, opts = {}) request_stripe_object( method: :post, path: "/v1/apps/secrets/delete", params: params, opts: opts ) end |
.find(params = {}, opts = {}) ⇒ Object
Finds a secret in the secret store by name and scope.
40 41 42 43 44 45 46 47 |
# File 'lib/stripe/resources/apps/secret.rb', line 40 def self.find(params = {}, opts = {}) request_stripe_object( method: :get, path: "/v1/apps/secrets/find", params: params, opts: opts ) end |
.list(params = {}, opts = {}) ⇒ Object
List all secrets stored on the given scope.
50 51 52 |
# File 'lib/stripe/resources/apps/secret.rb', line 50 def self.list(params = {}, opts = {}) request_stripe_object(method: :get, path: "/v1/apps/secrets", params: params, opts: opts) end |
.object_name ⇒ Object
20 21 22 |
# File 'lib/stripe/resources/apps/secret.rb', line 20 def self.object_name "apps.secret" end |