β Get informations about user
This route will returns all possible user types and their corresponding userField.
Description
ENDPOINT | DESCRIPTION | METHOD | EXEMPLE |
---|---|---|---|
/_plugin/Comexposium/thirdParty/getUser/{email}?appToken={appToken} | Get basic informations about an email | GET | https://api.preprod.comexposium-sso.com/_plugin/Comexposium/thirdParty/getUser/[email protected]?appToken=21sd2sdf32s1df3s2d1f |
Call Exemple
curl -X GET "https://api.preprod.comexposium-sso.com/_plugin/Comexposium/thirdParty/getUser/my%email.com?appToken=bf2a3d992662961be37727603s2d1321sd32f" -H "accept: application/json" -H "Authorization: Bearer token"
Details
Responses
You can only get a 200 status code by using this endpoint, you will find results in the statusCode attribute.
Success
statusCode: 0, message: generic_success, data: { profileData: { data of user }, status: active || inactive || deleted } }
Exemple:
{
"requestId": "885f2a79-67d7-44c1-88ca-ddbf2d53a94e",
"status": 200,
"error": null,
"controller": "Comexposium/thirdPartyController",
"action": "getUserForThirdParty",
"collection": null,
"index": null,
"volatile": null,
"result": {
"statusCode": 0,
"message": "generic_success",
"data": {
"profileData": {
"firstname": "Madame A",
"lastname": "A",
"mobilephone:indicatif": "+33",
"civility": "0",
"mobilephone:content": "00000000000",
"country": "ABW"
},
"status": "active"
}
}
}
Errors
statusCode: 138 || 171 || 172 || 173: Internal error
statusCode: 137: Missing credentials
statusCode: 139: Email does not exists
statusCode: 140: wrong configuration in application Token, contact Comexposium for more informations
statusCode: 149: Invalid applicationToken
statusCode: 181: applicationToken not authorized to modify
Exemple:
{
"requestId": "38624151-9832-44d8-a05f-cf8602ba09fa",
"status": 200,
"error": null,
"controller": "Comexposium/thirdPartyController",
"action": "getUserForThirdParty",
"collection": null,
"index": null,
"volatile": null,
"result": {
"statusCode": 139,
"message": "generic_error"
}
}