Find a Secret

Changed on

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

get/v1/apps/secrets/find

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/apps/secrets/find
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

namestring required

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

type'account' | 'user' required
userstring

Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.

Response

Successful response.

createdinteger required

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

deletedboolean

If true, indicates that this secret has been deleted

expires_atinteger nullable

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

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

namestring required

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

object'apps.secret' required

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

payloadstring nullable

The plaintext secret value to be stored.

Changes

  • 8b5c2f03d4cdRevision changes
    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    This list may be incomplete.

  • e24a26de4188Revision changes
    • breaking

      removed the required property //////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    This list may be incomplete.

Some revisions have not been checked yet.