getSecretValue( )

Retrieves the secret value specified by the secret name.

The getSecretValue() function returns a Promise that resolves to the value of the secret with the specified given name.

Note: Only use a secret's value in the backend code. Returning the secret value in the frontend is a security risk.

Admin Method

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Secrets
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
namestringRequired

The name of the secret to get the value of.

Returns
Return Type:Promise<GetSecretValueResponse>
Was this helpful?
Yes
No