Skip to content

ref: cleanup managed credential docs #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 18, 2017
Merged

ref: cleanup managed credential docs #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6845225
ref: cleanup managed credential docs
Dec 15, 2017
f637d9a
and/or
Dec 18, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions src/data/endpoints/managed.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,22 +247,33 @@ endpoints:
"username": "myusername2",
}' \
https://$api_root/$version/managed/credentials/$credential_id
/managed/credentials/$id/password:
/managed/credentials/$id/update:
group: Credentials
type: resource
authenticated: true
description: >
Change the password for a credential.
Change the username and/or password for a credential.
methods:
POST:
response: ManagedCredential
description: >
Changes the password for a credential.
Changes the username and/or password for a credential.
params:
username:
optional: True
description: New username to set for this credential.
value: myusername
type: String
password:
description: New password to set for this credential.
value: mypassword
type: String
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

password is required but username isn't? That's ...weird 😕

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Weird, but correct.

examples:
curl: |
curl -H "Content-Type: application/json" \
-H "Authorization: Bearer $TOKEN" \
-X POST -d '{
"username": "myusername",
"pasword": "mypassword",
}' \
https://$api_root/$version/managed/credentials/$credential_id/password
Expand Down
19 changes: 0 additions & 19 deletions src/data/objects/managedcredential.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,3 @@ schema:
value: CredentialLabel
description: >
A unique Label describing the credential.
username:
type: String
value: myusername
description: >
An optional login username.
last_decryption:
type: Object
description: >
The username and datetime of the last login using this credential.
who:
type: String
value: myusername
description: >
The username of the last successful login.
when:
type: Datetime
value: 2017-10-31T11:12:21
description: >
The datetime of the last successful login.