targetdomains

Download Spec

get /secrets-manager/api/v1/targetdomains

Get all target domains

sortkey

string

sortdir

string

Enum
  • asc
  • desc

limit

int

offset

int

Response

ExamplesSchema

Success

{
  "count": 123,
  "items": [
    {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "name": "string",
      "domain_name": "string",
      "enabled": true,
      "periodic_scan": true,
      "periodic_scan_interval": 0,
      "scan_status": "SCAN_ONGOING",
      "scan_message": "string",
      "last_scanned": "2023-06-07T17:32:28Z",
      "auto_onboarding": true,
      "auto_onboarding_policy": {
        "id": "5bf77342-221c-11ee-be56-0242ac120002",
        "name": "string"
      },
      "endpoints": [
        {
          "type": "AD",
          "scan_priority": 1,
          "rotation_priority": 0,
          "attribute_mapping": {},
          "ldap_protocol": "string",
          "ldap_address": "string",
          "ldap_port": 123,
          "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": "https://www.example.com",
          "entra_tenant_id": "5bf77342-221c-11ee-be56-0242ac120002",
          "entra_client_id": "5bf77342-221c-11ee-be56-0242ac120002",
          "entra_client_secret": "string",
          "entra_batch_size": 123,
          "entra_page_size": 123,
          "entra_group_filter": [
            "string"
          ]
        }
      ],
      "comment": "string",
      "created": "2023-06-07T17:32:28Z",
      "author": "5bf77342-221c-11ee-be56-0242ac120002",
      "updated": "2023-06-07T17:32:28Z",
      "updated_by": "5bf77342-221c-11ee-be56-0242ac120002"
    }
  ]
}

post /secrets-manager/api/v1/targetdomains

Create a target domain

id

string

uuid

name

string

Target domain name

domain_name

string

Target domain directory domain name

enabled

boolean

periodic_scan

boolean

Enable / disable periodic scan of target domain accounts

periodic_scan_interval

int

Periodic scan interval in seconds

Min
0
Max
31536000

scan_status

string

Enum
  • SCAN_ONGOING
  • SCAN_ERROR
  • SCAN_COMPLETED

scan_message

string

Scan failure reason

last_scanned

string

date-time

auto_onboarding

boolean

Enable/disable target domain account onboarding

auto_onboarding_policy

object (auto_onboarding_policy)

endpoints

array[object]

comment

string

created

string

date-time

author

string

uuid

updated

string

date-time

updated_by

string

uuid

Request

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002",
  "name": "string",
  "domain_name": "string",
  "enabled": true,
  "periodic_scan": true,
  "periodic_scan_interval": 0,
  "scan_status": "SCAN_ONGOING",
  "scan_message": "string",
  "last_scanned": "2023-06-07T17:32:28Z",
  "auto_onboarding": true,
  "auto_onboarding_policy": {
    "id": "5bf77342-221c-11ee-be56-0242ac120002",
    "name": "string"
  },
  "endpoints": [
    {
      "type": "AD",
      "scan_priority": 1,
      "rotation_priority": 0,
      "attribute_mapping": {},
      "ldap_protocol": "string",
      "ldap_address": "string",
      "ldap_port": 123,
      "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": "https://www.example.com",
      "entra_tenant_id": "5bf77342-221c-11ee-be56-0242ac120002",
      "entra_client_id": "5bf77342-221c-11ee-be56-0242ac120002",
      "entra_client_secret": "string",
      "entra_batch_size": 123,
      "entra_page_size": 123,
      "entra_group_filter": [
        "string"
      ]
    }
  ],
  "comment": "string",
  "created": "2023-06-07T17:32:28Z",
  "author": "5bf77342-221c-11ee-be56-0242ac120002",
  "updated": "2023-06-07T17:32:28Z",
  "updated_by": "5bf77342-221c-11ee-be56-0242ac120002"
}

Response

ExamplesSchema

Target domain was successfully created

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002"
}

post /secrets-manager/api/v1/targetdomains/search

Create a target domain

keywords

string

Space or comma separated list of search keywords

enabled

boolean

periodic_scan

boolean

auto_onboarding

boolean

Request

{
  "keywords": "string",
  "enabled": true,
  "periodic_scan": true,
  "auto_onboarding": true
}

Response

ExamplesSchema

Success

{
  "count": 123,
  "items": [
    {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "name": "string",
      "domain_name": "string",
      "enabled": true,
      "periodic_scan": true,
      "periodic_scan_interval": 0,
      "scan_status": "SCAN_ONGOING",
      "scan_message": "string",
      "last_scanned": "2023-06-07T17:32:28Z",
      "auto_onboarding": true,
      "auto_onboarding_policy": {
        "id": "5bf77342-221c-11ee-be56-0242ac120002",
        "name": "string"
      },
      "endpoints": [
        {
          "type": "AD",
          "scan_priority": 1,
          "rotation_priority": 0,
          "attribute_mapping": {},
          "ldap_protocol": "string",
          "ldap_address": "string",
          "ldap_port": 123,
          "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": "https://www.example.com",
          "entra_tenant_id": "5bf77342-221c-11ee-be56-0242ac120002",
          "entra_client_id": "5bf77342-221c-11ee-be56-0242ac120002",
          "entra_client_secret": "string",
          "entra_batch_size": 123,
          "entra_page_size": 123,
          "entra_group_filter": [
            "string"
          ]
        }
      ],
      "comment": "string",
      "created": "2023-06-07T17:32:28Z",
      "author": "5bf77342-221c-11ee-be56-0242ac120002",
      "updated": "2023-06-07T17:32:28Z",
      "updated_by": "5bf77342-221c-11ee-be56-0242ac120002"
    }
  ]
}

get /secrets-manager/api/v1/targetdomains/{targetDomainID}

Get target domain

targetDomainID

string

uuid

required

Response

ExamplesSchema

Success

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002",
  "name": "string",
  "domain_name": "string",
  "enabled": true,
  "periodic_scan": true,
  "periodic_scan_interval": 0,
  "scan_status": "SCAN_ONGOING",
  "scan_message": "string",
  "last_scanned": "2023-06-07T17:32:28Z",
  "auto_onboarding": true,
  "auto_onboarding_policy": {
    "id": "5bf77342-221c-11ee-be56-0242ac120002",
    "name": "string"
  },
  "endpoints": [
    {
      "type": "AD",
      "scan_priority": 1,
      "rotation_priority": 0,
      "attribute_mapping": {},
      "ldap_protocol": "string",
      "ldap_address": "string",
      "ldap_port": 123,
      "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": "https://www.example.com",
      "entra_tenant_id": "5bf77342-221c-11ee-be56-0242ac120002",
      "entra_client_id": "5bf77342-221c-11ee-be56-0242ac120002",
      "entra_client_secret": "string",
      "entra_batch_size": 123,
      "entra_page_size": 123,
      "entra_group_filter": [
        "string"
      ]
    }
  ],
  "comment": "string",
  "created": "2023-06-07T17:32:28Z",
  "author": "5bf77342-221c-11ee-be56-0242ac120002",
  "updated": "2023-06-07T17:32:28Z",
  "updated_by": "5bf77342-221c-11ee-be56-0242ac120002"
}

put /secrets-manager/api/v1/targetdomains/{targetDomainID}

Modify a target domain

id

string

uuid

name

string

Target domain name

domain_name

string

Target domain directory domain name

enabled

boolean

periodic_scan

boolean

Enable / disable periodic scan of target domain accounts

periodic_scan_interval

int

Periodic scan interval in seconds

Min
0
Max
31536000

scan_status

string

Enum
  • SCAN_ONGOING
  • SCAN_ERROR
  • SCAN_COMPLETED

scan_message

string

Scan failure reason

last_scanned

string

date-time

auto_onboarding

boolean

Enable/disable target domain account onboarding

auto_onboarding_policy

object (auto_onboarding_policy)

endpoints

array[object]

comment

string

created

string

date-time

author

string

uuid

updated

string

date-time

updated_by

string

uuid

Request

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002",
  "name": "string",
  "domain_name": "string",
  "enabled": true,
  "periodic_scan": true,
  "periodic_scan_interval": 0,
  "scan_status": "SCAN_ONGOING",
  "scan_message": "string",
  "last_scanned": "2023-06-07T17:32:28Z",
  "auto_onboarding": true,
  "auto_onboarding_policy": {
    "id": "5bf77342-221c-11ee-be56-0242ac120002",
    "name": "string"
  },
  "endpoints": [
    {
      "type": "AD",
      "scan_priority": 1,
      "rotation_priority": 0,
      "attribute_mapping": {},
      "ldap_protocol": "string",
      "ldap_address": "string",
      "ldap_port": 123,
      "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": "https://www.example.com",
      "entra_tenant_id": "5bf77342-221c-11ee-be56-0242ac120002",
      "entra_client_id": "5bf77342-221c-11ee-be56-0242ac120002",
      "entra_client_secret": "string",
      "entra_batch_size": 123,
      "entra_page_size": 123,
      "entra_group_filter": [
        "string"
      ]
    }
  ],
  "comment": "string",
  "created": "2023-06-07T17:32:28Z",
  "author": "5bf77342-221c-11ee-be56-0242ac120002",
  "updated": "2023-06-07T17:32:28Z",
  "updated_by": "5bf77342-221c-11ee-be56-0242ac120002"
}

Response

ExamplesSchema

Target domain was successfully modified

Empty response

delete /secrets-manager/api/v1/targetdomains/{targetDomainID}

Delete a target domain

targetDomainID

string

uuid

required

Response

ExamplesSchema

Target domain was successfully deleted

Empty response

post /secrets-manager/api/v1/targetdomains/{targetDomainID}/refresh

Trigger target domain account scan

targetDomainID

string

uuid

required

Response

ExamplesSchema

Target domain account scan was successfully triggered

Empty response

Was this page helpful?