Skip to main content

List identity-verification candidates (external integration)​

External-integration twin of GetSensorsVerificationCandidates. The integration filters by the caller's email address to learn the subject's identity id and which verification methods are available to them, then calls the matching initiate endpoint.

An empty result is a displayable helpdesk answer ("this caller cannot be verified"), not an error. Note that a caller belonging to a connection other than the configured one also reads as empty — a misconfiguration, so validate connection_id at install time.

Query Parameters
  • limit integer

    Possible values: <= 1000

    The maximum number of items to return in the result. Maximum value is 1000.

  • offset integer

    The number of the first item to be returned in the result

  • filter string

    A filter to be applied to the result list, using the SCIM 2.0 Filter syntax. By default, both active and disabled entities are returned. Deleted entities are never returned.

    Example (id_eq): id eq "1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b"
    Example (identity_type_eq): identity_type eq "snowflake_user"
    Example (source_type_eq): source_type eq "snowflake_account"
    Example (blast_radius_risk_eq): blast_radius_risk eq "critical"
    Example (composite_risk_eq): composite_risk eq "critical"
    Example (status_eq): status eq "active"
    Example (name_co): name co "test"
    Example (identifier_from_source_co): identifier_from_source co "00fsgh1234"
    Example (detection_type_eq): detection_type eq "MissingMFA"
    Example (connection_name_eq): connection_name eq "AWSAccount1"
    Example (connection_id_eq): connection_id eq "conn_id"
  • sort string[]

    The attributes on which identities should be sorted in the response, with optional ordering directives. The default sort order is ascending. Multiple comma-separated values can be provided, and sorting will be applied in that order.

    Example (name_ascending): name:ascending
    Example (name_descending): name:descending
    Example (source_ascending): source:ascending
    Example (source_descending): source:descending
    Example (identity_type_ascending): identity_type:ascending
    Example (identity_type_descending): identity_type:descending
    Example (blast_radius_risk_ascending): blast_radius_risk:ascending
    Example (blast_radius_risk_descending): blast_radius_risk:descending
    Example (composite_risk_descending): composite_risk:descending
    Example (multiple_fields_one): identity_type:ascending,blast_radius_risk:descending
    Example (multiple_fields_two): blast_radius_risk:descending,identity_type:ascending
  • operator_email email required

    The human operating the integration. MUST be derived server-side by the integration, never supplied by its own client. Resolved to a SlashID console person holding a verifier role.

  • operator_assertion string required

    Possible values: [integration_asserted, idp_verified]

    How the operator identity was established.

  • connection_id string required
Header Parameters
  • SlashID-OrgID string required

    The organization ID

    Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1
Responses

Verification candidates list

Schema
  • result object[]
  • meta object
  • pagination object
  • limit integer
  • offset integer
  • total_count int64
  • cursor_pagination object

    Cursors are opaque. Follow the tokens the server returns; never construct, parse or modify one.

  • limit integer
  • next_cursor string

    Opaque token addressing the next page. Absent on the last page.

  • prev_cursor string

    Opaque token addressing the previous page. Absent on the first page.

  • last_cursor string

    Opaque token addressing the final page directly, so a client can jump to the end without a total count.

  • total_count int64

    Total number of matching items. Returned on the FIRST page only; clients cache it for the remainder of the walk.