Class: Stripe::Apps::Secret

Inherits:
Stripe::APIResource show all
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)

Defined Under Namespace

Classes: CreateParams, DeleteWhereParams, FindParams, ListParams, Scope

Constant Summary collapse

OBJECT_NAME = 
"apps.secret"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from Stripe::APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Methods included from Stripe::APIOperations::Create

create

Methods included from Stripe::APIOperations::List

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

included

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

Instance Attribute Details

#created ⇒ Object (readonly)

Time at which the object was created. Measured in seconds since the Unix epoch.



164
165
166
 
# File 'lib/stripe/resources/apps/secret.rb', line 164

def created
  @created
end

#deleted ⇒ Object (readonly)

If true, indicates that this secret has been deleted



167
168
169
 
# File 'lib/stripe/resources/apps/secret.rb', line 167

def deleted
  @deleted
end

#expires_at ⇒ Object (readonly)

The Unix timestamp for the expiry time of the secret, after which the secret deletes.



170
171
172
 
# File 'lib/stripe/resources/apps/secret.rb', line 170

def expires_at
  @expires_at
end

#id ⇒ Object (readonly)

Unique identifier for the object.



173
174
175
 
# File 'lib/stripe/resources/apps/secret.rb', line 173

def id
  @id
end

#livemode ⇒ Object (readonly)

Has the value ‘true` if the object exists in live mode or the value `false` if the object exists in test mode.



176
177
178
 
# File 'lib/stripe/resources/apps/secret.rb', line 176

def livemode
  @livemode
end

#name ⇒ Object (readonly)

A name for the secret that’s unique within the scope.



179
180
181
 
# File 'lib/stripe/resources/apps/secret.rb', line 179

def name
  @name
end

#object ⇒ Object (readonly)

String representing the object’s type. Objects of the same type share the same value.



182
183
184
 
# File 'lib/stripe/resources/apps/secret.rb', line 182

def object
  @object
end

#payload ⇒ Object (readonly)

The plaintext secret value to be stored.



185
186
187
 
# File 'lib/stripe/resources/apps/secret.rb', line 185

def payload
  @payload
end

#scope ⇒ Object (readonly)

Attribute for field scope



188
189
190
 
# File 'lib/stripe/resources/apps/secret.rb', line 188

def scope
  @scope
end

Class Method Details

.create(params = {}, opts = {}) ⇒ Object

Create or replace a secret in the secret store.



191
192
193
 
# File 'lib/stripe/resources/apps/secret.rb', line 191

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.



196
197
198
199
200
201
202
203
 
# File 'lib/stripe/resources/apps/secret.rb', line 196

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.



206
207
208
209
210
211
212
213
 
# File 'lib/stripe/resources/apps/secret.rb', line 206

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.



216
217
218
 
# File 'lib/stripe/resources/apps/secret.rb', line 216

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