Skip to main content
Version: v41

targetdomains

List of target domains

countinteger
items object[]
  • Array [
  • idstring<uuid>
    namestring

    Target domain name

    domain_namestring

    Target domain directory domain name

    enabledboolean
    periodic_scanboolean

    Enable / disable periodic scan of target domain accounts

    periodic_scan_intervalinteger

    Periodic scan interval in seconds

    Possible values: >= 0 and <= 31536000

    scan_statusstring

    Possible values: [SCAN_ONGOING, SCAN_ERROR, SCAN_COMPLETED]

    scan_messagestring

    Scan failure reason

    last_scannedstring<date-time>
    auto_onboardingboolean

    Enable/disable target domain account onboarding

    auto_onboarding_policy policy_handle

    Password policy used in auto onboarding, required if auto onboarding is enabled

    idstring<uuid>
    namestring
    endpoints object[]
  • Array [
  • typestring

    Possible values: [AD, Entra]

    scan_priorityinteger

    Scanning priority, 0 to disable scanning

    Possible values: >= 1 and <= 1000

    rotation_priorityinteger

    Rotation priority, 0 to disable rotation

    Possible values: >= 0 and <= 2

    attribute_mappingobject
    ldap_protocolstring
    ldap_addressstring
    ldap_portinteger
    ldap_base_dnstring
    ldap_bind_dnstring
    ldap_bind_passwordstring
    ldap_user_filterstring
    ldap_root_certificatesstring
    ldap_skip_strict_cert_checkboolean
    entra_base_urlstring<uri>
    entra_tenant_idstring<uuid>
    entra_client_idstring<uuid>
    entra_client_secretstring
    entra_batch_sizeinteger
    entra_page_sizeinteger
    entra_group_filterstring[]
  • ]
  • commentstring
    createdstring<date-time>
    authorstring<uuid>
    updatedstring<date-time>
    updated_bystring<uuid>
  • ]
  • targetdomains
    {
    "count": 0,
    "items": [
    {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "domain_name": "string",
    "enabled": true,
    "periodic_scan": true,
    "periodic_scan_interval": 0,
    "scan_status": "SCAN_ONGOING",
    "scan_message": "string",
    "last_scanned": "2024-07-29T15:51:28.071Z",
    "auto_onboarding": true,
    "auto_onboarding_policy": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
    },
    "endpoints": [
    {
    "type": "AD",
    "scan_priority": 0,
    "rotation_priority": 0,
    "attribute_mapping": {},
    "ldap_protocol": "string",
    "ldap_address": "string",
    "ldap_port": 0,
    "ldap_base_dn": "string",
    "ldap_bind_dn": "string",
    "ldap_bind_password": "string",
    "ldap_user_filter": "string",
    "ldap_root_certificates": "string",
    "ldap_skip_strict_cert_check": true,
    "entra_base_url": "string",
    "entra_tenant_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "entra_client_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "entra_client_secret": "string",
    "entra_batch_size": 0,
    "entra_page_size": 0,
    "entra_group_filter": [
    "string"
    ]
    }
    ],
    "comment": "string",
    "created": "2024-07-29T15:51:28.071Z",
    "author": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "updated": "2024-07-29T15:51:28.071Z",
    "updated_by": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
    ]
    }