The secret store type
true if the given secret store type can have mappings, false otherwise
Create an empty secret store export template
an empty secret store export template
Create secret store mapping. Will throw if type is not defined and multiple secret stores with the same id are found.
Secret store id
Secret store type id (optional)
The secret store mapping data,
true if the secret store is global, false otherwise. Default: false.
a promise that resolves to a secret store mapping object of the mapping created
Delete secret store by id
Secret store id
Secret store type id (optional)
true if the secret store mapping is global, false otherwise. Default: false.
a promise that resolves to a secret store object
Delete secret store mapping
Secret store id
Secret store type id (optional)
Secret store mapping label. It is the last segment of the URL of the mapping, that is the _id of the mapping: it equals the label for a mapping that this library or the admin console created, but not for one created without an _id (the server then generates one and answers 404 to the label)
true if the secret store mapping is global, false otherwise. Default: false.
a promise that resolves to a secret store mapping object
Delete secret store mappings
Secret store id
Secret store type id (optional)
true if the secret store mapping is global, false otherwise. Default: false.
OptionalresultCallback: ResultCallback<SecretStoreMappingSkeleton>
Optional callback to process individual results
a promise that resolves to a secret store mapping object
Delete all secret stores
true if the secret store mappings are global, false otherwise. Default: false.
OptionalresultCallback: ResultCallback<SecretStoreSkeleton>
Optional callback to process individual results
a promise that resolves to an array of secret store objects
Export a single secret store by id. The response can be saved to file as is. Will throw if type is not defined and multiple secret stores with the same id are found.
Secret store id
Secret store type id (optional)
true if global secret store is the target of the operation, false otherwise. Default: false.
Promise resolving to a SecretStoreExportInterface object.
Export all secret stores. The response can be saved to file as is. A secret store whose mappings cannot be read is not exported: the callback gets one error that names the store, or, without a callback, the function throws.
true if global secret stores are the target of the operation, false otherwise. Default: false.
OptionalresultCallback: ResultCallback<SecretStoreSkeleton>
Optional callback to process individual results
Promise resolving to a SecretStoreExportInterface object.
Import secret stores and mappings. A secret store that cannot be imported, or one of whose mappings cannot be imported, is reported to the callback once as an error that names the store, and is not part of the result.
secret store import data
true if the secret store mapping is global, false otherwise. Default: false.
OptionalsecretStoreId: string
optional secret store id. If supplied, only the secret store of that id is imported.
OptionalsecretStoreTypeId: string
optional secret store type id
OptionalresultCallback: ResultCallback<SecretStoreSkeleton>
Optional callback to process individual results
the imported secret stores and mappings
Read secret store by id. Will throw if type is not defined and multiple secret stores with the same id are found.
Secret store id
Secret store type id (optional)
true if global secret store is the target of the operation, false otherwise. Default: false.
a promise that resolves to a secret store object
Read secret store mapping. Will throw if type is not defined and multiple secret stores with the same id are found.
Secret store id
Secret store type id (optional)
Secret store mapping label
true if the secret store is global, false otherwise. Default: false.
a promise that resolves to an array of secret store mapping objects
Read secret store mappings. Will throw if type is not defined and multiple secret stores with the same id are found.
Secret store id
Secret store type id (optional)
true if the secret store is global, false otherwise. Default: false.
a promise that resolves to an array of secret store mapping objects
Read all secret stores.
true if global secret stores are the target of the operation, false otherwise. Default: false.
a promise that resolves to an array of secret store objects
Read secret store schema
Secret store type id
true if the secret store is global, false otherwise. Default: false.
a promise that resolves to a secret store schema object
Update secret store
secret store to import
true if the secret store is global, false otherwise. Default: false.
a promise that resolves to a secret store object
Update secret store mapping. Will throw if type is not defined and multiple secret stores with the same id are found.
Secret store id
Secret store type id (optional)
secret store mapping to import
true if the secret store mapping is global, false otherwise. Default: false.
a promise that resolves to a secret store mapping object
Function that returns true if the given secret store type can have mappings, false otherwise