- 3 minutes to read
- Print
- DarkLight
- PDF
GET | List all passwords
- 3 minutes to read
- Print
- DarkLight
- PDF
Access information of passwords stored in MySafe.
Request
GET
api/mysafe/password
Query parameters
Send the parameters below as URL query.
tag
- string - Filters passwords by the tag registered.name
- string - Filters passwords by their name.username
- string - Filters passwords by the username registered.url
- string - Filters passwords by the URL registered.
Example request
GET
{{url}}api/mysafe/password
- Lists all passwords.
GET
{{url}}api/mysafe/password?tag=gmail
- Lists password(s) registered with the tag
= gmail
.
GET
{{url}}api/mysafe/password?name=Github
- Lists password(s) registered with the name
= Github
.
GET
{{url}}api/mysafe/password?username=dleite
Lists password(s) registered with the usernam
= dleite
.
GET
{{url}}api/mysafe/password?url=www.gmail.com
- Lists password(s) registered with the url
= www.gmail.com
.
Response
HTTP/1.1 200 OK
{
"code": 200,
"response": {
"status": 200,
"message": "",
"error": false,
"error_code": 0,
"detail": "",
"mensagem": "",
"erro": false,
"cod_erro": 0
},
"password_on_list": [
{
"identifier": "3",
"name": "Github",
"url": "https://github.com",
"username": "[email protected]",
"tags": "",
"need_justify": "0",
"need_approval": "0",
"can_view": true,
"can_write": true
},
{
"identifier": "4",
"name": "gmail personal",
"url": "www.gmail.com",
"username": "[email protected]",
"tags": "gmail",
"need_justify": "0",
"need_approval": "0",
"can_view": true,
"can_write": true
},
{
"identifier": "5",
"name": "gmail corporate",
"url": "www.gmail.com",
"username": "[email protected]",
"tags": "gmail",
"need_justify": "0",
"need_approval": "0",
"can_view": true,
"can_write": true
},
{
"identifier": "6",
"name": "senhasegura",
"url": "www.senhasegura.com",
"username": "dleite",
"tags": "senhasegura",
"need_justify": "0",
"need_approval": "0",
"can_view": true,
"can_write": true
}
]
}
Response body fields
passwords_on_list
- array of objects - Data of the saved passwords.identifier
- string - Numeric unique identification code of the password.name
- string - Name of the password.url
- string - URL of the website where the password is being used.username
- string Username used to access the account.password
- string - The password that's being added.secret_key
- string - The secret key provided for multi-factor authentication.token
- string - The TOTP code generated by senhasegura for multi-factor authentication based on the secret key provided in POST | Create password.tags
- string - Keywords associated with the password.users_allowed
- string - array of objects - Data of the users with password access.username
- string - Name of the user with password access permission.can_write
- boolean - Editing permission.Users with can_write
= true
permission can disable the password.
groups_allowed
- string - array of objects - Data of the groups with password access.name
- string - Name of the group with password access permission.can_write
- boolean - Editing permission.Group members with can_write
= true
permission can disable the password.
Errors
500 - Internal Server Error.
Message: "Unexpected error."
Possible cause: the error is in the senhasegura server.
Solution: contact the support team for more information.
No route matched with those values.
Message: "You are not authorized to access this resource."
Possíveis causas: failure in your application authentication with the senhasegura server.
Solution: check the authentication parameters such as Access Token URL
, Client ID
and Client Secret
and request a new access token or check and correct the URL.
An invalid response was received from the upstream server .
Message: "An invalid response was received from the a seupstream server
Possible cause: the upstream server may be taking too long to respond, leading to a timeout error that is interpreted as an invalid response by the proxy/gateway server.
Solution: check the connectivity between the source of the request and the senhasegura server.
The upstream server is timing out.
Message: "The upstream server is timing out"
Possible cause: the request time has expired.
Solution: check the connectivity between the source of the request and the senhasegura server.