API ReferenceSecret Scanner

Update detected secret resolution status

View as Markdown
Updates the resolution status of a secret detected in a workspace.

Authentication

x-api-keystring
API Key authentication via header
OR
Authorizationstring
A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.
OR
AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

secretIdstringRequired
The secret's ID.

Request

This endpoint expects an object.
resolutionenumRequired

The secret’s updated resolution status:

  • FALSE_POSITIVE — The discovered secret is not an actual secret.
  • REVOKED — The secret is valid, but the user rotated their key to resolve the issue.
  • ACCEPTED_RISK — The Secret Scanner found the secret, but user accepts the risk of publishing it.
workspaceIdstringRequired
The ID of the workspace that contains the secret.

Response

Successful Response
secretHashstring

The SHA-256 hash of the detected secret.

workspaceIdstring
The ID of the workspace that contains the secret.
resolutionenum

The secret’s current resolution status:

  • ACTIVE — The secret is active.
  • FALSE_POSITIVE — The discovered secret is not an actual secret.
  • REVOKED — The secret is valid, but the user rotated their key to resolve the issue.
  • ACCEPTED_RISK — The Secret Scanner found the secret, but user accepts the risk of publishing it.
historylist of objects
The history of the secret's resolution status changes.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error