Package com.stripe.model.apps

Class Secret

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.apps.Secret

All Implemented Interfaces:

HasId, StripeActiveObject, StripeObjectInterface

public class Secret
extends ApiResource
implements HasId

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Secret.Scope	For more details about Scope, please refer to the API Reference.

Nested classes/interfaces inherited from class com.stripe.net.ApiResource

ApiResource.RequestMethod

Field Summary

Fields inherited from class com.stripe.net.ApiResource

CHARSET, GSON, INTERNAL_GSON

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor	Description
Secret()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
static Secret	create(SecretCreateParams params)	Create or replace a secret in the secret store.
static Secret	create(SecretCreateParams params, RequestOptions options)	Create or replace a secret in the secret store.
static Secret	create(Map<String,Object> params)	Create or replace a secret in the secret store.
static Secret	create(Map<String,Object> params, RequestOptions options)	Create or replace a secret in the secret store.
static Secret	deleteWhere(SecretDeleteWhereParams params)	Deletes a secret from the secret store by name and scope.
static Secret	deleteWhere(SecretDeleteWhereParams params, RequestOptions options)	Deletes a secret from the secret store by name and scope.
static Secret	deleteWhere(Map<String,Object> params)	Deletes a secret from the secret store by name and scope.
static Secret	deleteWhere(Map<String,Object> params, RequestOptions options)	Deletes a secret from the secret store by name and scope.
boolean	equals(Object o)
static Secret	find(SecretFindParams params)	Finds a secret in the secret store by name and scope.
static Secret	find(SecretFindParams params, RequestOptions options)	Finds a secret in the secret store by name and scope.
static Secret	find(Map<String,Object> params)	Finds a secret in the secret store by name and scope.
static Secret	find(Map<String,Object> params, RequestOptions options)	Finds a secret in the secret store by name and scope.
Long	getCreated()	Time at which the object was created.
Boolean	getDeleted()	If true, indicates that this secret has been deleted.
Long	getExpiresAt()	The Unix timestamp for the expiry time of the secret, after which the secret deletes.
String	getId()	Unique identifier for the object.
Boolean	getLivemode()	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
String	getName()	A name for the secret that's unique within the scope.
String	getObject()	String representing the object's type.
String	getPayload()	The plaintext secret value to be stored.
Secret.Scope	getScope()
int	hashCode()
static SecretCollection	list(SecretListParams params)	List all secrets stored on the given scope.
static SecretCollection	list(SecretListParams params, RequestOptions options)	List all secrets stored on the given scope.
static SecretCollection	list(Map<String,Object> params)	List all secrets stored on the given scope.
static SecretCollection	list(Map<String,Object> params, RequestOptions options)	List all secrets stored on the given scope.
void	setCreated(Long created)	Time at which the object was created.
void	setDeleted(Boolean deleted)	If true, indicates that this secret has been deleted.
void	setExpiresAt(Long expiresAt)	The Unix timestamp for the expiry time of the secret, after which the secret deletes.
void	setId(String id)	Unique identifier for the object.
void	setLivemode(Boolean livemode)	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
void	setName(String name)	A name for the secret that's unique within the scope.
void	setObject(String object)	String representing the object's type.
void	setPayload(String payload)	The plaintext secret value to be stored.
void	setResponseGetter(StripeResponseGetter responseGetter)	Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.
void	setScope(Secret.Scope scope)

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, getGlobalResponseGetter, getResponseGetter, setExpandableFieldId, setGlobalResponseGetter, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject

deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.stripe.model.StripeActiveObject

trySetResponseGetter

Constructor Details

Secret

public Secret()

Method Details

create

public static Secret create(Map<String,Object> params)
                     throws StripeException

Create or replace a secret in the secret store.

Throws:

StripeException

create

public static Secret create(Map<String,Object> params,
 RequestOptions options)
                     throws StripeException

Create or replace a secret in the secret store.

Throws:

StripeException

create

public static Secret create(SecretCreateParams params)
                     throws StripeException

Create or replace a secret in the secret store.

Throws:

StripeException

create

public static Secret create(SecretCreateParams params,
 RequestOptions options)
                     throws StripeException

Create or replace a secret in the secret store.

Throws:

StripeException

deleteWhere

public static Secret deleteWhere(Map<String,Object> params)
                          throws StripeException

Deletes a secret from the secret store by name and scope.

Throws:

StripeException

deleteWhere

public static Secret deleteWhere(Map<String,Object> params,
 RequestOptions options)
                          throws StripeException

Deletes a secret from the secret store by name and scope.

Throws:

StripeException

deleteWhere

public static Secret deleteWhere(SecretDeleteWhereParams params)
                          throws StripeException

Deletes a secret from the secret store by name and scope.

Throws:

StripeException

deleteWhere

public static Secret deleteWhere(SecretDeleteWhereParams params,
 RequestOptions options)
                          throws StripeException

Deletes a secret from the secret store by name and scope.

Throws:

StripeException

find

public static Secret find(Map<String,Object> params)
                   throws StripeException

Finds a secret in the secret store by name and scope.

Throws:

StripeException

find

public static Secret find(Map<String,Object> params,
 RequestOptions options)
                   throws StripeException

Finds a secret in the secret store by name and scope.

Throws:

StripeException

find

public static Secret find(SecretFindParams params)
                   throws StripeException

Finds a secret in the secret store by name and scope.

Throws:

StripeException

find

public static Secret find(SecretFindParams params,
 RequestOptions options)
                   throws StripeException

Finds a secret in the secret store by name and scope.

Throws:

StripeException

list

public static SecretCollection list(Map<String,Object> params)
                             throws StripeException

List all secrets stored on the given scope.

Throws:

StripeException

list

public static SecretCollection list(Map<String,Object> params,
 RequestOptions options)
                             throws StripeException

List all secrets stored on the given scope.

Throws:

StripeException

list

public static SecretCollection list(SecretListParams params)
                             throws StripeException

List all secrets stored on the given scope.

Throws:

StripeException

list

public static SecretCollection list(SecretListParams params,
 RequestOptions options)
                             throws StripeException

List all secrets stored on the given scope.

Throws:

StripeException

setResponseGetter

public void setResponseGetter(StripeResponseGetter responseGetter)

Description copied from interface: StripeActiveObject

Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.

Specified by:

setResponseGetter in interface StripeActiveObject

Overrides:

setResponseGetter in class ApiResource

Parameters:

responseGetter - the StripeResponseGetter instance to use for making further requests.

getCreated

public Long getCreated()

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

getDeleted

public Boolean getDeleted()

If true, indicates that this secret has been deleted.

getExpiresAt

public Long getExpiresAt()

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

getLivemode

public Boolean getLivemode()

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

getName

public String getName()

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

getObject

public String getObject()

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

Equal to apps.secret.

getPayload

public String getPayload()

The plaintext secret value to be stored.

getScope

public Secret.Scope getScope()

setCreated

public void setCreated(Long created)

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

setDeleted

public void setDeleted(Boolean deleted)

If true, indicates that this secret has been deleted.

setExpiresAt

public void setExpiresAt(Long expiresAt)

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

setId

public void setId(String id)

Unique identifier for the object.

setLivemode

public void setLivemode(Boolean livemode)

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

setName

public void setName(String name)

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

setObject

public void setObject(String object)

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

Equal to apps.secret.

setPayload

public void setPayload(String payload)

The plaintext secret value to be stored.

setScope

public void setScope(Secret.Scope scope)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getId

public String getId()

Unique identifier for the object.

Specified by:

getId in interface HasId