Skip to content

Commit 17ae7db

Browse files
committed
updated docs to include response changes
Signed-off-by: Kobbi Gal <[email protected]>
1 parent de52964 commit 17ae7db

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

secretstores/akeyless/README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,3 +121,51 @@ curl http://localhost:3500/v1.0/secrets/akeyless/bulk
121121
- Supports static, dynamic and rotated secrets.
122122
- **GetSecret**: Retrieve an individual value secret by path.
123123
- **BulkGetSecret**: Retrieve an all secrets from the root path.
124+
125+
## Response Formats
126+
127+
The Akeyless secret store returns different response formats depending on the secret type:
128+
129+
### Static Secrets
130+
Static secrets return their value directly as a string:
131+
132+
```json
133+
{
134+
"my-static-secret": "secret-value"
135+
}
136+
```
137+
138+
### Dynamic Secrets
139+
Dynamic secrets return a JSON string containing the credentials. The exact structure depends on the target system:
140+
141+
**MySQL Dynamic Secret:**
142+
```json
143+
{
144+
"my-mysql-secret": "{\"user\":\"generated_username\",\"password\":\"generated_password\",\"ttl_in_minutes\":\"60\",\"id\":\"username\"}"
145+
}
146+
```
147+
148+
**Azure AD Dynamic Secret:**
149+
```json
150+
{
151+
"my-azure-secret": "{\"user\":{\"id\":\"user_id\",\"displayName\":\"user_name\",\"mail\":\"[email protected]\"},\"secret\":{\"keyId\":\"secret_key_id\",\"displayName\":\"secret_name\",\"tenantId\":\"tenant_id\"},\"ttl_in_minutes\":\"60\",\"id\":\"user_id\",\"msg\":\"User has been added successfully...\"}"
152+
}
153+
```
154+
155+
**GCP Dynamic Secret:**
156+
```json
157+
{
158+
"my-gcp-secret": "{\"encoded_key\":\"base64_encoded_service_account_key\",\"ttl_in_minutes\":\"60\",\"id\":\"service_account_name\"}"
159+
}
160+
```
161+
162+
### Rotated Secrets
163+
Rotated secrets return a JSON object containing all available fields:
164+
165+
```json
166+
{
167+
"my-rotated-secret": "{\"value\":{\"username\":\"rotated_user\",\"password\":\"rotated_password\",\"application_id\":\"1234567890\"}}"
168+
}
169+
```
170+
171+
**Note:** The exact fields in dynamic and rotated secret responses vary by target system and configuration. Applications should parse the JSON string to extract the specific credentials they need.

0 commit comments

Comments
 (0)