- 2 minutes to read
- Print
- DarkLight
- PDF
GET | List all related users
- 2 minutes to read
- Print
- DarkLight
- PDF
Access related users’ information in senhasegura.
Requirements
- Authorization with access permission to the Users resource granted by the administrator in A2A.
Access the document on How to create an authorization for an application for more information.
Request
GET
/api/user/related
Example Request
GET
{{url}}api/user/related
Response
HTTP/1.1 200 OK
{
"code": 200,
"response": {
"status": 200,
"message": "6 related users found",
"error": false,
"error_code": 0,
"detail": "",
"mensagem": "6 related users found",
"erro": false,
"cod_erro": 0
},
"relatedUsers": [
{
"id": "1",
"name": "amandalices",
"username": "alices"
},
{
"id": "2",
"name": "dleite",
"username": "dleite"
},
{
"id": "4",
"name": "deboraleite",
"username": "dleite"
},
{
"id": "5",
"name": "dleitef",
"username": "dleite"
},
{
"id": "6",
"name": "deboraleiteferreira",
"username": "dleite"
},
{
"id": "8",
"name": "duarte",
"username": "paulopilotti"
}
]
}
Response Body Fields
relatedUsers
- array of objects - Related users’ 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
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.