Create Finding

Create a user-authored custom finding.

POST /api/v1/findings

CreateFinding

Go

package main

import(
	"context"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/shared"
	conductoronesdkgo "github.com/conductorone/conductorone-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := conductoronesdkgo.New(
        conductoronesdkgo.WithSecurity(shared.Security{
            BearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
            Oauth: "<YOUR_OAUTH_HERE>",
        }),
    )

    res, err := s.Finding.CreateFinding(ctx, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.CreateFindingResponse != nil {
        // handle response
    }
}

200

{
  "finding": {
    "annotations": {},
    "appId": "<string>",
    "appResourceTarget": {
      "appId": "<string>",
      "appResourceId": "<string>",
      "appResourceTypeId": "<string>"
    },
    "appUserTarget": {
      "appId": "<string>",
      "appUserId": "<string>"
    },
    "assignedOwner": {
      "appOwnerAppId": "<string>",
      "identityUserId": "<string>",
      "managerOfUserId": "<string>",
      "userSetId": "<string>"
    },
    "computedOwner": {
      "appOwnerAppId": "<string>",
      "identityUserId": "<string>",
      "managerOfUserId": "<string>",
      "userSetId": "<string>"
    },
    "connectorAnomalyDetectionDisabled": {},
    "connectorTarget": {
      "appId": "<string>",
      "connectorId": "<string>"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "credentialExpiring": {
      "credentialDisplayName": "<string>",
      "userClientId": "<string>"
    },
    "credentialExpiringEvidence": {
      "expired": true,
      "expiresAt": "2023-11-07T05:31:56Z"
    },
    "credentialPubliclyExposed": {
      "connectorClientId": "<string>",
      "connectorManagedCredentialId": "<string>",
      "credentialDisplayName": "<string>",
      "functionClientId": "<string>",
      "userClientId": "<string>"
    },
    "credentialPubliclyExposedEvidence": {
      "credentialRevoked": true,
      "fingerprintPrefix": "<string>",
      "firstObservedAt": "2023-11-07T05:31:56Z",
      "firstScannerId": "<string>",
      "reportingScanners": [
        "<string>"
      ],
      "revokedAt": "2023-11-07T05:31:56Z",
      "sourceKind": "<string>",
      "sourceUrl": "<string>"
    },
    "custom": {},
    "customSubType": "<string>",
    "customTags": {},
    "deactivatedOwner": {
      "source": "DEACTIVATED_OWNER_SOURCE_UNSPECIFIED"
    },
    "deactivatedOwnerEvidence": {
      "deactivatedOwners": [
        {
          "reason": "DEACTIVATED_OWNER_REASON_UNSPECIFIED",
          "userId": "<string>"
        }
      ]
    },
    "decoyCredentialUsed": {
      "decoyId": "<string>",
      "kind": "DECOY_CREDENTIAL_KIND_UNSPECIFIED"
    },
    "decoyPubliclyExposed": {
      "decoyDisplayName": "<string>",
      "decoyId": "<string>"
    },
    "decoyPubliclyExposedEvidence": {
      "credentialRevoked": true,
      "fingerprintPrefix": "<string>",
      "firstObservedAt": "2023-11-07T05:31:56Z",
      "firstScannerId": "<string>",
      "reportingScanners": [
        "<string>"
      ],
      "revokedAt": "2023-11-07T05:31:56Z",
      "sourceKind": "<string>",
      "sourceUrl": "<string>"
    },
    "decoyTarget": {
      "decoyId": "<string>"
    },
    "dedupKeyParts": [
      "<string>"
    ],
    "description": "<string>",
    "fingerprint": "<string>",
    "firstObservedAt": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "identityUserTarget": {
      "identityUserId": "<string>"
    },
    "lastAppearedAt": "2023-11-07T05:31:56Z",
    "lastObservedAt": "2023-11-07T05:31:56Z",
    "nhiUnowned": {},
    "recurrenceCount": 123,
    "remediationDescription": "<string>",
    "resolvedAt": "2023-11-07T05:31:56Z",
    "riskAcceptanceExpiresAt": "2023-11-07T05:31:56Z",
    "riskAcceptanceJustification": "<string>",
    "riskScore": {
      "originalScore": 123,
      "overrideByUserId": "<string>",
      "overrideScore": 123,
      "riskFactors": [
        {
          "description": "<string>",
          "name": "<string>",
          "severity": "FINDING_SEVERITY_UNSPECIFIED",
          "weight": 123
        }
      ],
      "score": 123,
      "systemScore": 123
    },
    "serviceAccountMisclassification": {
      "currentAccountType": "APP_USER_TYPE_UNSPECIFIED",
      "detectedAccountType": "APP_USER_TYPE_UNSPECIFIED"
    },
    "serviceAccountMisclassificationEvidence": {
      "detectionReason": "<string>"
    },
    "serviceAccountUnowned": {},
    "severity": "FINDING_SEVERITY_UNSPECIFIED",
    "similarUsernameMatch": {
      "proposedIdentityUserId": "<string>"
    },
    "similarUsernameMatchEvidence": {
      "appUsername": "<string>",
      "identityUsername": "<string>",
      "similarityScore": 123
    },
    "snoozeReason": "<string>",
    "snoozeUntil": "2023-11-07T05:31:56Z",
    "sourceDetectorId": "<string>",
    "sourceKind": "FINDING_SOURCE_KIND_UNSPECIFIED",
    "state": "FINDING_STATE_UNSPECIFIED",
    "stateUpdatedById": "<string>",
    "suppressReason": "<string>",
    "taskId": "<string>",
    "tenantTarget": {},
    "unusedSecret": {},
    "unusedSecretEvidence": {
      "lastUsedAt": "2023-11-07T05:31:56Z"
    },
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization · string · header · required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Body

application/json

The CreateFindingRequest message.

This message contains a oneof named target. Only a single field of the following list may be set at a time:

• identityUserTarget
• appUserTarget
• decoyTarget
• appResourceTarget
• connectorTarget
• tenantTarget

annotations · object

Arbitrary metadata attached to the finding; filterable by routing rules.

Show child attributes

appResourceTarget · App Resource Target · object | null

AppResourceTarget points at the app resource the finding is about.

Show child attributes

appUserTarget · App User Target · object | null

The AppUserTarget message.

Show child attributes

connectorTarget · Connector Target · object | null

ConnectorTarget points at the connector that produced this finding.

Show child attributes

customSubType · string

User-supplied sub-classification (e.g. "shadow_it"). Part of the dedup identity and filterable via FindingSearch.

decoyTarget · Decoy Target · object | null

DecoyTarget points at the planted decoy that produced this finding. Populated for findings whose subject is the decoy artifact itself (e.g. decoy_credential_used), giving the UI and routing rules a uniform handle to the decoy alongside the finding_type payload.

Show child attributes

dedupKeyParts · string[] | null

Caller-supplied dedup identity. The fingerprint is a domain-separated SHA-256 over ("custom", custom_sub_type, dedup_key_parts...) — see pkg/uhash; parts cannot collide regardless of their byte content. Two creates with the same parts collapse onto one finding. Must be non-empty and every part must be non-empty.

description · string

Optional finding body (markdown by convention).

identityUserTarget · Identity User Target · object | null

The IdentityUserTarget message.

Show child attributes

remediationDescription · string

Optional remediation guidance, used as the body of any task created from this finding.

severity · enum<string>

Severity of the finding. Must be a defined, non-unspecified value.

Available options: FINDING_SEVERITY_UNSPECIFIED, FINDING_SEVERITY_INFO, FINDING_SEVERITY_LOW, FINDING_SEVERITY_MEDIUM, FINDING_SEVERITY_HIGH, FINDING_SEVERITY_CRITICAL

tenantTarget · Tenant Target · object | null

TenantTarget scopes a finding to the whole tenant. It carries no subject id; the finding's tenant is the scope.

Response

200 - application/json

Successful response

The CreateFindingResponse message.

finding · Finding · object | null

The Finding message.

This message contains a oneof named finding_type. Only a single field of the following list may be set at a time:

• similarUsernameMatch
• serviceAccountMisclassification
• nhiUnowned
• serviceAccountUnowned
• decoyCredentialUsed
• custom
• connectorAnomalyDetectionDisabled
• deactivatedOwner
• unusedSecret
• credentialPubliclyExposed
• decoyPubliclyExposed
• credentialExpiring

This message contains a oneof named target. Only a single field of the following list may be set at a time:

• identityUserTarget
• appUserTarget
• decoyTarget
• appResourceTarget
• tenantTarget
• connectorTarget

This message contains a oneof named evidence. Only a single field of the following list may be set at a time:

• similarUsernameMatchEvidence
• serviceAccountMisclassificationEvidence
• deactivatedOwnerEvidence
• unusedSecretEvidence
• credentialPubliclyExposedEvidence
• decoyPubliclyExposedEvidence
• credentialExpiringEvidence

Show child attributes