Skip to content
API Reference
API Reference
Zones
Secrets

Retrieve

zones.secrets.retrieve(strid, SecretRetrieveParams**kwargs) -> SecretRetrieveResponse
GET/zones/{zone_id}/secrets/{id}
ParametersExpand Collapse
zone_id: str

A globally unique opaque identifier

minLength1
id: str
x_client_request_id: Optional[str]
formatuuid
ReturnsExpand Collapse
class SecretRetrieveResponse: …
id: str

A globally unique opaque identifier

minLength1
created_at: datetime
formatdate-time
data: Data
Accepts one of the following:
class SecretTokenFields: …
token: str
type: Literal["token"]
class SecretPasswordFields: …
password: str
type: Literal["password"]
username: str
entity_id: str

A globally unique opaque identifier

minLength1
name: str

A name for the entity to be displayed in UI

updated_at: datetime
formatdate-time
version: int
minimum1
zone_id: str

A globally unique opaque identifier

minLength1
description: Optional[str]

A description of the entity

maxLength128
metadata: Optional[object]

A JSON object containing arbitrary metadata. Metadata will not be encrypted.

Retrieve

from keycardai_api import KeycardAPI

client = KeycardAPI()
secret = client.zones.secrets.retrieve(
    id="id",
    zone_id="x",
)
print(secret.id)
{
  "id": "x",
  "created_at": "2019-12-27T18:11:19.117Z",
  "data": {
    "token": "token",
    "type": "token"
  },
  "entity_id": "x",
  "name": "name",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "version": 1,
  "zone_id": "x",
  "description": "description",
  "metadata": {}
}
Returns Examples
{
  "id": "x",
  "created_at": "2019-12-27T18:11:19.117Z",
  "data": {
    "token": "token",
    "type": "token"
  },
  "entity_id": "x",
  "name": "name",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "version": 1,
  "zone_id": "x",
  "description": "description",
  "metadata": {}
}