GET | List a related user
- 2 minutes to read
- Print
- DarkLight
- PDF
GET | List a related user
- 2 minutes to read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Access a related user’s Information in senhasegura.
Requirements
- Authorization with access permission to the Users resource granted by the A2A administrator.
Access the document on How to create an authorization for an application for more information.
Request
GET /api/user/related/[id]
Request parameters
Send the parameter below in the path of the URL.
id - int - required- Related user unique identification code.Note: this value is automatically assigned by senhasegura in POST | Create related user and is obtained in the response to the GET | List all related users request.
Example Request
GET {{url}}/api/user/related/2
Response
HTTP/1.1 200 OK
{
"code": 200,
"response": {
"status": 200,
"message": "",
"error": false,
"error_code": 0,
"detail": "",
"mensagem": "",
"erro": false,
"cod_erro": 0
},
"relatedUsers": {
"id": "4",
"name": "deboraleite",
"username": "dleite"
}
}
Response Body Fields
relatedUsers - object - Related user’s data.id - int - Related user unique identification code generated automatically by senhasegura in POST | Create related user.name - string - Name assigned to the related user.username - string - Identification name for the user in senhasegura.Errors
400 - Bad Request.
Message: "1005: User does not exist"
Possible cause: the id provided hasn’t returned a user registered in senhasegura.
Solution: provide a valid id and resend the request.
404 - Not Found.
Message: "Resource sub not found"
Possible cause: the URL or requested resource isn’t correct.
Solution: check the URL and make sure all the parameters are correct.
500 - Internal Server Error.
Message: "Unexpected error."
Possible cause: the error is in the senhasegura server.
Solution: contact the support team for more information.
Message: "You are not authorized to access this resource."
Possible cause: you don’t have the authorization to access this resource.
Solution: ask the administrator to check your permission to access the Users resources in A2A.
Client authentication failed.
Message: "Client authentication failed."
Possible cause: 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.
Invalid signature.
Message: "Invalid signature"
Possible cause: failure in recognizing the URL of the client application.
Solution: check the URL of the client application and resend the request.
No route matched with those values.
Message: "No route matched with those values."
Possible cause: the authorization header is missing in the API request.
Solution: request a new access token.
Request timed out.
Message: "Request timed 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?
