targetdomain accounts

Download Spec

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

Get all accounts in target domain

sortkey

string

sortdir

string

Enum
  • asc
  • desc

limit

int

offset

int

Response

ExamplesSchema

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

Search accounts in target domain

keywords

string

Space or comma separated list of search keywords

created_after

string

date-time

created_before

string

date-time

updated_after

string

date-time

updated_before

string

date-time

state

string

Enum
  • MANAGED
  • UNMANAGED
  • NEW
  • REMOVED

ignored

boolean

Request

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

ExamplesSchema

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 target domain account

targetDomainID

string

uuid

required

accountID

string

uuid

required

Response

ExamplesSchema

Success

Empty response

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

Modify target domain account

ignored

boolean

comment

string

Request

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

Response

ExamplesSchema

Account was successfully modified

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

post /secrets-manager/api/v1/targetdomains/{targetDomainID}/accounts/batch/edit

Modify target domain account

ids

array[string]

changes

object (changes)

Request

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

Response

ExamplesSchema

Account batch was successfully modified

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

Was this page helpful?