Authorizer

secrets

Download Spec

get/authorizer/api/v1/secrets

Get all accessible account secrets

limitint

Maximum number of objects to return

Default: 25

offsetint

Offset from which to start fetching objects

Default: 0

sortdirstring

Sort direction, asc or desc

Default: "ASC"
Enum: ASC
DESC

sortkeystring

Sort by specific object property

Default: "id"

Responses

Response examples

Successful request

{
  "count": 123,
  "items": {
    "path": "string",
    "type": "TARGET_DOMAIN_SECRET",
    "username": "string",
    "email": "string",
    "full_name": "string",
    "target_domain": {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "name": "string",
      "deleted": true
    },
    "host": {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "addresses": [
        "string"
      ],
      "common_name": "string",
      "external_id": "string",
      "instance_id": "string"
    },
    "created": "2023-06-07T17:32:28Z",
    "updated": "2023-06-07T17:32:28Z"
  }
}

post/authorizer/api/v1/secrets/search

Search accessible account secrets

keywordsstring

Space or comma separated list of search keywords

host_idstring

Limit search to specific host object

Format: uuid

usernamestring

Limit search to specific host account username

Responses

Request examples

{
  "keywords": "string",
  "host_id": "5bf77342-221c-11ee-be56-0242ac120002",
  "username": "string"
}

Response examples

Successful request

{
  "count": 123,
  "items": {
    "path": "string",
    "type": "TARGET_DOMAIN_SECRET",
    "username": "string",
    "email": "string",
    "full_name": "string",
    "target_domain": {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "name": "string",
      "deleted": true
    },
    "host": {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "addresses": [
        "string"
      ],
      "common_name": "string",
      "external_id": "string",
      "instance_id": "string"
    },
    "created": "2023-06-07T17:32:28Z",
    "updated": "2023-06-07T17:32:28Z"
  }
}

get/authorizer/api/v1/secrets/checkouts

Get secret checkouts

limitint

Maximum number of objects to return

Default: 25

offsetint

Offset from which to start fetching objects

Default: 0

sortdirstring

Sort direction, asc or desc

Default: "ASC"
Enum: ASC
DESC

sortkeystring

Sort by specific object property

Default: "id"

Responses

Response examples

Successful request

{
  "count": 123,
  "items": {
    "id": "5bf77342-221c-11ee-be56-0242ac120002",
    "path": "string",
    "type": "TARGET_DOMAIN_SECRET",
    "expires": "2023-06-07T17:32:28Z",
    "created": "2023-06-07T17:32:28Z",
    "explicit_checkout": true,
    "secrets": [
      {
        "version": 123,
        "secret": "string",
        "created": "2023-06-07T17:32:28Z"
      }
    ],
    "username": "string",
    "email": "string",
    "full_name": "string",
    "target_domain": {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "name": "string",
      "deleted": true
    },
    "host": {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "addresses": [
        "string"
      ],
      "common_name": "string",
      "external_id": "string",
      "instance_id": "string"
    },
    "managed_account_id": "5bf77342-221c-11ee-be56-0242ac120002",
    "user_id": "5bf77342-221c-11ee-be56-0242ac120002"
  }
}

post/authorizer/api/v1/secrets/checkouts

Checkout account secret

pathstring

Path of secret

Responses

Request examples

{
  "path": "string"
}

Response examples

Successful request

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002",
  "path": "string",
  "type": "TARGET_DOMAIN_SECRET",
  "expires": "2023-06-07T17:32:28Z",
  "created": "2023-06-07T17:32:28Z",
  "explicit_checkout": true,
  "secrets": [
    {
      "version": 123,
      "secret": "string",
      "created": "2023-06-07T17:32:28Z"
    }
  ],
  "username": "string",
  "email": "string",
  "full_name": "string",
  "target_domain": {
    "id": "5bf77342-221c-11ee-be56-0242ac120002",
    "name": "string",
    "deleted": true
  },
  "host": {
    "id": "5bf77342-221c-11ee-be56-0242ac120002",
    "addresses": [
      "string"
    ],
    "common_name": "string",
    "external_id": "string",
    "instance_id": "string"
  },
  "managed_account_id": "5bf77342-221c-11ee-be56-0242ac120002",
  "user_id": "5bf77342-221c-11ee-be56-0242ac120002"
}

get/authorizer/api/v1/secrets/checkouts/{id}

Get secret checkout

idstring

required

Format: uuid

Responses

Response examples

Successful request

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002",
  "path": "string",
  "type": "TARGET_DOMAIN_SECRET",
  "expires": "2023-06-07T17:32:28Z",
  "created": "2023-06-07T17:32:28Z",
  "explicit_checkout": true,
  "secrets": [
    {
      "version": 123,
      "secret": "string",
      "created": "2023-06-07T17:32:28Z"
    }
  ],
  "username": "string",
  "email": "string",
  "full_name": "string",
  "target_domain": {
    "id": "5bf77342-221c-11ee-be56-0242ac120002",
    "name": "string",
    "deleted": true
  },
  "host": {
    "id": "5bf77342-221c-11ee-be56-0242ac120002",
    "addresses": [
      "string"
    ],
    "common_name": "string",
    "external_id": "string",
    "instance_id": "string"
  },
  "managed_account_id": "5bf77342-221c-11ee-be56-0242ac120002",
  "user_id": "5bf77342-221c-11ee-be56-0242ac120002"
}

post/authorizer/api/v1/secrets/checkouts/{id}/release

Release secret checkout

idstring

required

Format: uuid

Responses

Response examples

Secret was successfully released

Empty response

Was this page helpful?