• Secrets Manager

targetdomain accounts

Target domain accounts

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

List target domain accounts

Get all accounts in a given target domain

sortkeystring

Case-insensitive target domain accounts sort key

Enum
  • id
  • username
  • email
  • full_name
sortdirstring

Case-insensitive sort order

Enum
  • asc
  • desc
limitint

Maximum number of collection items to return

Default
50
Min
0
Max
1000
offsetint

Collection query offset

Default
0
Min
0

Responses

Response examples

Success

{
  "count": 123,
  "items": [
    {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "username": "string",
      "email": "string",
      "full_name": "string",
      "source_id": "string",
      "security_id": "string",
      "additional_data": {},
      "target_domain": {
        "id": "5bf77342-221c-11ee-be56-0242ac120002",
        "name": "string",
        "deleted": true
      },
      "state": "MANAGED",
      "ignored": true,
      "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/{targetDomainID}/accounts/search

Find target domain accounts

Find accounts in a given target domain

keywordsstring

Space or comma separated list of search keywords

created_afterstring
Format
date-time
created_beforestring
Format
date-time
updated_afterstring
Format
date-time
updated_beforestring
Format
date-time
statestring
Enum
  • MANAGED
  • UNMANAGED
  • NEW
  • REMOVED
ignoredboolean

Responses

Request examples

{
  "keywords": "string",
  "created_after": "2023-06-07T17:32:28Z",
  "created_before": "2023-06-07T17:32:28Z",
  "updated_after": "2023-06-07T17:32:28Z",
  "updated_before": "2023-06-07T17:32:28Z",
  "state": "MANAGED",
  "ignored": true
}

Response examples

Success

{
  "count": 123,
  "items": [
    {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "username": "string",
      "email": "string",
      "full_name": "string",
      "source_id": "string",
      "security_id": "string",
      "additional_data": {},
      "target_domain": {
        "id": "5bf77342-221c-11ee-be56-0242ac120002",
        "name": "string",
        "deleted": true
      },
      "state": "MANAGED",
      "ignored": true,
      "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}/accounts/{accountID}

Get a target domain account

Get a target domain account by ID

targetDomainIDstring

required

Format
uuid
accountIDstring

required

Format
uuid

Responses

Response examples

Success

Empty response

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

Update a target domain account

Update a target domain account by ID

ignoredboolean
commentstring

Responses

Request examples

{
  "ignored": true,
  "comment": "string"
}

Response examples

Account was successfully modified

{
  "version": 123,
  "created": "2023-06-07T17:32:28Z"
}
post/secrets-manager/api/v1/targetdomains/{targetDomainID}/accounts/batch/edit

Batch edit target domain accounts

Batch edit target domain accounts

idsarray
Format
uuid
changesobject (scannedaccount_changes)

Target domain account changes

ignoredboolean
commentstring

Responses

Request examples

{
  "ids": [
    "5bf77342-221c-11ee-be56-0242ac120002"
  ],
  "changes": {
    "ignored": true,
    "comment": "string"
  }
}

Response examples

Account batch was successfully modified

{
  "version": 123,
  "created": "2023-06-07T17:32:28Z"
}

Was this page helpful?