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.
- scope.
typeenumRequired The secret scope type.
Possible enum valuesaccount
A secret scoped to an account. Use this for API keys or other secrets that should be accessible by all UI Extension contexts.
user
A secret scoped to a specific user. Use this for oauth tokens or other per-user secrets. If this is set,
scope.
must also be set.user - scope.
userstring The user ID. This field is required if
type
is set touser
, and should not be provided iftype
is set toaccount
.
More parameters
- ending_
beforestring A cursor for use in pagination.
ending_
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withbefore obj_
, your subsequent call can includebar ending_
in order to fetch the previous page of the list.before=obj_ bar - limitinteger
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_
afterstring A cursor for use in pagination.
starting_
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withafter obj_
, your subsequent call can includefoo starting_
in order to fetch the next page of the list.after=obj_ foo
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" } } ]}