Skip to content

Commit 6845225

Browse files
author
Steve Szyszkiewicz
committed
ref: cleanup managed credential docs
* remove username and last_decrypted from the response * move /:id/password to /:id/update
1 parent 2c83d15 commit 6845225

File tree

2 files changed

+14
-22
lines changed

2 files changed

+14
-22
lines changed

src/data/endpoints/managed.yaml

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -247,22 +247,33 @@ endpoints:
247247
"username": "myusername2",
248248
}' \
249249
https://$api_root/$version/managed/credentials/$credential_id
250-
/managed/credentials/$id/password:
250+
/managed/credentials/$id/update:
251251
group: Credentials
252252
type: resource
253253
authenticated: true
254254
description: >
255-
Change the password for a credential.
255+
Change the username and password for a credential.
256256
methods:
257257
POST:
258258
response: ManagedCredential
259259
description: >
260-
Changes the password for a credential.
260+
Changes the username and password for a credential.
261+
params:
262+
username:
263+
optional: True
264+
description: New username to set for this credential.
265+
value: myusername
266+
type: String
267+
password:
268+
description: New password to set for this credential.
269+
value: mypassword
270+
type: String
261271
examples:
262272
curl: |
263273
curl -H "Content-Type: application/json" \
264274
-H "Authorization: Bearer $TOKEN" \
265275
-X POST -d '{
276+
"username": "myusername",
266277
"pasword": "mypassword",
267278
}' \
268279
https://$api_root/$version/managed/credentials/$credential_id/password

src/data/objects/managedcredential.yaml

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -14,22 +14,3 @@ schema:
1414
value: CredentialLabel
1515
description: >
1616
A unique Label describing the credential.
17-
username:
18-
type: String
19-
value: myusername
20-
description: >
21-
An optional login username.
22-
last_decryption:
23-
type: Object
24-
description: >
25-
The username and datetime of the last login using this credential.
26-
who:
27-
type: String
28-
value: myusername
29-
description: >
30-
The username of the last successful login.
31-
when:
32-
type: Datetime
33-
value: 2017-10-31T11:12:21
34-
description: >
35-
The datetime of the last successful login.

0 commit comments

Comments
 (0)