GET | List a password by [identifier]
  • 3 minutes to read
  • Dark
    Light
  • PDF

GET | List a password by [identifier]

  • Dark
    Light
  • PDF

Article summary

Access a password information in MySafe.

Requirements

  • Password access in MySafe.

Request

GET api/mysafe/password/[identifier]

Request parameters

Send the parameter below in the path of the URL.

Example request

GET {{url}}api/mysafe/password/5

Response

HTTP/1.1 200 OK 
{
    "code": 200,
    "response": {
        "status": 200,
        "message": "Success",
        "error": false,
        "error_code": 0,
        "detail": "",
        "Message": "Success",
        "erro": false,
        "cod_erro": 0
    },
    "password_entity": {
        "identifier": "5",
        "name": "gmail corporate",
        "url": "www.gmail.com",
        "username": "[email protected]",
        "password": "7yha&thisismycorporatepassword78%h",
        "secret_key": null,
        "token": null,
        "notes": "my gmail password",
        "tags": "gmail",
        "users_allowed": [],
        "groups_allowed": []
    }
}

Response body fields

passwords_entity - array of objects - Password data.


    → 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.


Attention

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.


Attention

Group members with can_write = true permission can disable the password.

Errors

400 - Bad Request.

Message: "1010: Unexpected identifier type"

Possible cause: the identifier sent wasn't recognized as valid.

Solution: check the value for the identifier and resend the request.

Message: "1005: Password not found"

Possible cause: the password wasn't found.

Solution: check the value for the identifier and resend the request.

Message: "1006: User does not have access"

Possible cause: user isn't allowed to access the item.


Message: "1009: Inactive password"

Possible cause: the password is inactive.

Solution: enable the password through PUT api/mysafe/password/active[identifier].
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.



Was this article helpful?

What's Next