List all secrets stored on the given scope.
Parameters
- scopeobjectRequired
Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
More parameters
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
A dictionary with a data
property that contains an array of up to limit
Secrets, starting after Secret starting_
. Each entry in the array is a separate Secret object. If no more Secrets are available, the resulting array will be empty.
{ "object": "list", "url": "/v1/apps/secrets", "has_more": false, "data": [ { "id": "appsecret_5110hHS1707T6fjBnah1LkdIwHu7ix", "object": "apps.secret", "created": 1680209063, "expires_at": null, "livemode": false, "name": "my-api-key", "scope": { "type": "account" } } ]}
Deletes a secret from the secret store by name and scope.
Parameters
- namestringRequired
A name for the secret that’s unique within the scope.
- scopeobjectRequired
Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
Returns
Returns the deleted secret object.
{ "id": "appsecret_5110hHS1707T6fjBnah1LkdIwHu7ix", "object": "apps.secret", "deleted": true}
Finds a secret in the secret store by name and scope.
Parameters
- namestringRequired
A name for the secret that’s unique within the scope.
- scopeobjectRequired
Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
Returns
Returns a secret object.
{ "id": "appsecret_5110hHS1707T6fjBnah1LkdIwHu7ix", "object": "apps.secret", "created": 1680209063, "expires_at": null, "livemode": false, "name": "my-api-key", "scope": { "type": "account" }}
Create or replace a secret in the secret store.
Parameters
- namestringRequired
A name for the secret that’s unique within the scope.
- payloadstringRequired
The plaintext secret value to be stored.
- scopeobjectRequired
Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
- expires_
attimestamp The Unix timestamp for the expiry time of the secret, after which the secret deletes.
Returns
Returns a secret object.
{ "id": "appsecret_5110hHS1707T6fjBnah1LkdIwHu7ix", "object": "apps.secret", "created": 1680209063, "expires_at": null, "livemode": false, "name": "my-api-key", "scope": { "type": "account" }}
Reserves allow Connect platforms who own liability for negative balances to hold a portion of a connected account’s funds to cover refunds and disputes and reduce loss exposure. The Reserves feature is part of the Radar for Platforms product which is currently in private preview. See this page to request early access.