Delete Credential

client.credentials.delete(, ?): CredentialDeleteResponse { id, deleted, object }

DELETE/v5/credentials/{credential_id}

Permanently delete a credential and all its associated data.

ParametersExpand Collapse

credentialID: string

ReturnsExpand Collapse

CredentialDeleteResponse { id, deleted, object }

id: string

deleted: boolean

object?: string

Delete Credential

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 credential = await client.credentials.delete('credential_id');

console.log(credential.id);

{
  "id": "id",
  "deleted": true,
  "object": "object"
}

Returns Examples

{
  "id": "id",
  "deleted": true,
  "object": "object"
}