Skip to content

User Information Endpoint

The User Information Endpoint is utilized post-authentication to retrieve essential user information, which can then be used by Teachify to personalize the user experience or manage user-specific data. This endpoint is crucial for accessing profile details that the user has consented to share under the authorized scopes during the OAuth process.

Functionality

After a successful authentication and authorization process, where the user grants Teachify permission to access their profile data, Teachify can request user information from this endpoint using the access token obtained. This ensures that only necessary data is accessed, respecting user privacy and adhering to minimal data access principles.

Detailed Explanation of the User Information Endpoint Purpose The User Information Endpoint is utilized post-authentication to retrieve essential user information, which can then be used by Teachify to personalize the user experience or manage user-specific data. This endpoint is crucial for accessing profile details that the user has consented to share under the authorized scopes during the OAuth process.

API Example

GET https://yourdomain.com/oauth/userinfo
Authorization: Bearer access_token

Key Parameters Authorization: This is a mandatory header where the Bearer access_token must be included. The access token is used to authenticate the request, ensuring that the request for user information is authorized. Sample Response The response from the User Information Endpoint typically includes JSON data containing the user’s details as specified by the scopes authorized. Below is an example of what this might look like:

User info example
{
"uid": "1234567890",
"name": "Jane Doe",
"email": "jane.doe@example.com",
"picture": "http://example.com/jane.jpg"
}

Fields Explained

  • uid: A unique identifier for the user, which is often used by the client to manage user sessions and database records.
  • name: The full name of the user.
  • email: The user’s email address, which can be used for communication or identification purposes.
  • picture: A URL to an image file representing the user’s profile picture.

This setup allows Teachify to effectively use the provided user data to enhance user interaction and provide a more tailored educational experience. By securing the endpoint and ensuring data is only available after proper authentication and authorization, both Teachify and your enterprise can maintain high standards of data privacy and security.