> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve User Information

> Use this endpoint to retrieve the user information using the OIDC standard.



## OpenAPI

````yaml /en/openapi/v3-current/AM-auth.yaml get /v1/userinfo
openapi: 3.1.0
info:
  title: Auth Plugin
  description: ''
  version: 2.6.5
servers:
  - url: https://auth.sandbox.lerian.net
security: []
tags:
  - name: Authentication API
  - name: MFA API
  - name: User Information API
  - name: Authorization API
paths:
  /v1/userinfo:
    get:
      tags:
        - User Information API
      summary: Retrieve User Information
      description: >-
        Use this endpoint to retrieve the user information using the OIDC
        standard.
      parameters:
        - $ref: '#/components/parameters/Authorization'
      responses:
        '200':
          description: >-
            Indicates that the resource was successfully created and the
            operation was completed as expected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserInfo'
              example:
                email: john@example.com
                emailVerified: true
                name: John Doe
                picture: https://example.com/picture.jpg
                preferredUsername: johndoe
                profile: https://example.com/profile
                sub: 019c96a0-5b20-7def-e1f2-9d0e1f2a3b4c
          headers: {}
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
              examples:
                Error0009:
                  $ref: '#/components/examples/Error0009'
          headers: {}
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
              examples:
                Error0006:
                  $ref: '#/components/examples/Error0006'
                Error0007:
                  $ref: '#/components/examples/Error0007'
          headers: {}
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
              examples:
                Error0008:
                  $ref: '#/components/examples/Error0008'
          headers: {}
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
              examples:
                Error0005:
                  $ref: '#/components/examples/Error0005'
          headers: {}
      security: []
components:
  parameters:
    Authorization:
      name: Authorization
      in: header
      description: The authorization token in the 'Bearer <token>' format.
      required: true
      schema:
        type: string
  schemas:
    UserInfo:
      description: >-
        Contains basic identity details for the authenticated user — useful for
        personalization, display, or authorization logic.
      type: object
      properties:
        email:
          type: string
          description: User's email address.
        emailVerified:
          type: boolean
          description: Indicates whether the email has been verified (true if verified).
        name:
          type: string
          description: Full name of the user.
        picture:
          type: string
          description: URL of the user's profile image.
        preferredUsername:
          type: string
          description: The name that will be displayed to the user.
        profile:
          type: string
          description: URL to the user's profile page.
        sub:
          type: string
          description: Unique identifier for the user (subject claim).
    ErrorMessage:
      description: The response message error.
      type: object
      properties:
        code:
          type: string
          description: A unique, stable identifier for the error.
        title:
          type: string
          description: A brief summary of the issue.
        message:
          type: string
          description: Detailed guidance for resolving the error.
  examples:
    Error0009:
      summary: Bad Request
      value:
        code: AUT-0009
        title: Bad Request
        message: >-
          The server could not understand the request due to malformed syntax.
          Please check the listed fields and try again.
    Error0006:
      summary: Token Missing
      value:
        code: AUT-0006
        title: Token Missing
        message: >-
          A valid token must be provided in the request header. Please include a
          token and try again.
    Error0007:
      summary: Invalid Token
      value:
        code: AUT-0007
        title: Invalid Token
        message: >-
          The provided token is expired, invalid or malformed. Please provide a
          valid token and try again.
    Error0008:
      summary: Permission Enforcement Error
      value:
        code: AUT-0008
        title: Permission Enforcement Error
        message: >-
          The enforcer is not configured properly. Please contact your
          administrator if you believe this is an error.
    Error0005:
      summary: Internal Server Error
      value:
        code: AUT-0005
        title: Internal Server Error
        message: >-
          The server encountered an unexpected error. Please try again later or
          contact support.

````