• Secrets Manager

targetdomains

get/secrets-manager/api/v1/targetdomains

Get all target domains

sortkeystring
sortdirstring
Enum
  • asc
  • desc
limitint
offsetint

Responses

Response examples

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

idstring
Format
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_intervalint

Periodic scan interval in seconds

Min
0
Max
31536000
scan_statusstring
Enum
  • SCAN_ONGOING
  • SCAN_ERROR
  • SCAN_COMPLETED
scan_messagestring

Scan failure reason

last_scannedstring
Format
date-time
auto_onboardingboolean

Enable/disable target domain account onboarding

auto_onboarding_policyobject (policy_handle)
idstring
Format
uuid
namestring
endpointsarray
typestring
Enum
  • AD
  • Entra
scan_priorityint

Scanning priority, 0 to disable scanning

Min
1
Max
1000
rotation_priorityint

Rotation priority, 0 to disable rotation

Min
0
Max
2
attribute_mappingobject
ldap_protocolstring
ldap_addressstring
ldap_portint
ldap_base_dnstring
ldap_bind_dnstring
ldap_bind_passwordstring
ldap_user_filterstring
ldap_root_certificatesstring
ldap_skip_strict_cert_checkboolean
entra_base_urlstring
Format
uri
entra_tenant_idstring
Format
uuid
entra_client_idstring
Format
uuid
entra_client_secretstring
entra_batch_sizeint
entra_page_sizeint
entra_group_filterarray
commentstring
createdstring
Format
date-time
authorstring
Format
uuid
updatedstring
Format
date-time
updated_bystring
Format
uuid

Responses

Request examples

{
  "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 examples

Target domain was successfully created

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002"
}
post/secrets-manager/api/v1/targetdomains/search

Create a target domain

keywordsstring

Space or comma separated list of search keywords

enabledboolean
periodic_scanboolean
auto_onboardingboolean

Responses

Request examples

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

Response examples

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

targetDomainIDstring

required

Format
uuid

Responses

Response examples

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

idstring
Format
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_intervalint

Periodic scan interval in seconds

Min
0
Max
31536000
scan_statusstring
Enum
  • SCAN_ONGOING
  • SCAN_ERROR
  • SCAN_COMPLETED
scan_messagestring

Scan failure reason

last_scannedstring
Format
date-time
auto_onboardingboolean

Enable/disable target domain account onboarding

auto_onboarding_policyobject (policy_handle)
idstring
Format
uuid
namestring
endpointsarray
typestring
Enum
  • AD
  • Entra
scan_priorityint

Scanning priority, 0 to disable scanning

Min
1
Max
1000
rotation_priorityint

Rotation priority, 0 to disable rotation

Min
0
Max
2
attribute_mappingobject
ldap_protocolstring
ldap_addressstring
ldap_portint
ldap_base_dnstring
ldap_bind_dnstring
ldap_bind_passwordstring
ldap_user_filterstring
ldap_root_certificatesstring
ldap_skip_strict_cert_checkboolean
entra_base_urlstring
Format
uri
entra_tenant_idstring
Format
uuid
entra_client_idstring
Format
uuid
entra_client_secretstring
entra_batch_sizeint
entra_page_sizeint
entra_group_filterarray
commentstring
createdstring
Format
date-time
authorstring
Format
uuid
updatedstring
Format
date-time
updated_bystring
Format
uuid

Responses

Request examples

{
  "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 examples

Target domain was successfully modified

Empty response

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

Delete a target domain

targetDomainIDstring

required

Format
uuid

Responses

Response examples

Target domain was successfully deleted

Empty response

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

Trigger target domain account scan

targetDomainIDstring

required

Format
uuid

Responses

Response examples

Target domain account scan was successfully triggered

Empty response

Was this page helpful?