Neucron
Search
⌃K
Comment on page

User Data API

The User Data API provides endpoints to retrieve user information, including private and public user data. This API is protected by Bearer Token Authentication, and the user ID is determined based on the claims provided in the authentication token.

Get User Private Info

/{userID}/data/privateInfo

This endpoint allows you to retrieve a user's private information. If an authentication token is present, the user ID is taken from the claims in the token. The user's private information is returned as a JSON response.
Endpoint Details:
  • HTTP Method: GET
  • Security: Bearer Token Authentication
  • Description: Get user private information.
  • Produces: application/json
  • Tags: User
  • Summary: Retrieve user private information.
Request Parameters:
  • X-Neucron-App-ID (Header) - The ID of the Neucron application.
  • X-Neucron-Key-ID (Header) - The ID of the Neucron key.
  • X-Neucron-Key-Secret (Header) - The secret key for authentication.
  • userID (Path) - The user ID for which you want to retrieve private information.
Response:
  • 200 OK - The user's private information is successfully retrieved. The response schema is defined as usermodel.UserInfoRes.
  • 400 Bad Request - Invalid request or missing parameters.
  • 404 Not Found - The requested user's private information is not found.
  • 500 Internal Server Error - An internal server error occurred.
Oops, something is missing.We could not find the original source to display this content.

Get User Public Info for Apps

/{userID}/data/publicInfo

This endpoint allows you to retrieve a user's public information for apps. If an authentication token is present, the user ID is taken from the claims in the token. The user's public information for apps is returned as a JSON response.
Endpoint Details:
  • HTTP Method: GET
  • Security: Bearer Token Authentication
  • Description: Get user public information for apps.
  • Produces: application/json
  • Tags: User
  • Summary: Retrieve user public information for apps.
Request Parameters:
  • X-Neucron-App-ID (Header) - The ID of the Neucron application.
  • X-Neucron-Key-ID (Header) - The ID of the Neucron key.
  • X-Neucron-Key-Secret (Header) - The secret key for authentication.
  • userID (Path) - The user ID for which you want to retrieve public information.
Response:
  • 200 OK - The user's public information for apps is successfully retrieved. The response schema is defined as usermodel.UserPubInfoRes.
  • 400 Bad Request - Invalid request or missing parameters.
  • 404 Not Found - The requested user's public information for apps is not found.
  • 500 Internal Server Error - An internal server error occurred.
Please ensure that you provide the required headers and a valid user ID when using these endpoints to retrieve user information. In case of any issues, the API will return appropriate error responses for further troubleshooting. If you have any questions or need more information about specific schemas, please refer to the corresponding documentation or contact the API support team.
Oops, something is missing.We could not find the original source to display this content.
​
Previous
Notification
Next - Assetyzer
Token Fundamentals
Last modified 3mo ago