Skip to content

Get Credential Secret by ID

client.credentials.decrypt(stringcredentialID, RequestOptionsoptions?): CredentialSecret { result, object }
POST/v5/credentials/{credential_id}/secret

Retrieve the plaintext payload of a credential by its ID.

ParametersExpand Collapse
credentialID: string
ReturnsExpand Collapse
CredentialSecret { result, object }
result: string
object?: string

Get Credential Secret by ID

import SGPClient from 'scale-gp';

const client = new SGPClient({
  accountID: 'My Account ID',
  apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});

const credentialSecret = await client.credentials.decrypt('credential_id');

console.log(credentialSecret.result);
{
  "result": "result",
  "object": "object"
}
Returns Examples
{
  "result": "result",
  "object": "object"
}