Skip to content

Commit 8e60dc8

Browse files
authored
Merge pull request #8 from SzySteve/docs/credential_refinement
ref: cleanup managed credential docs
2 parents 075800e + f637d9a commit 8e60dc8

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
@@ -265,22 +265,33 @@ endpoints:
265265
"username": "myusername2",
266266
}' \
267267
https://$api_root/$version/managed/credentials/$credential_id
268-
/managed/credentials/$id/password:
268+
/managed/credentials/$id/update:
269269
group: Credentials
270270
type: resource
271271
authenticated: true
272272
description: >
273-
Change the password for a credential.
273+
Change the username and/or password for a credential.
274274
methods:
275275
POST:
276276
response: ManagedCredential
277277
description: >
278-
Changes the password for a credential.
278+
Changes the username and/or password for a credential.
279+
params:
280+
username:
281+
optional: True
282+
description: New username to set for this credential.
283+
value: myusername
284+
type: String
285+
password:
286+
description: New password to set for this credential.
287+
value: mypassword
288+
type: String
279289
examples:
280290
curl: |
281291
curl -H "Content-Type: application/json" \
282292
-H "Authorization: Bearer $TOKEN" \
283293
-X POST -d '{
294+
"username": "myusername",
284295
"pasword": "mypassword",
285296
}' \
286297
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)