Jump to

• Request
• Response

Generate User Details Using Access Token

get

/oauth2/v1/userinfo

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

User information generated

Body ()

Root Schema : userinfo

Type: object

Generate the user information in JSON format.

Show Source

• birthdate: string
  Birthdate of the user
• family_name: string
  Family name of the user
• gender: string
  Gender of the user
• given_name: string
  First name of the user
• name: string
  Name of the user
• preferred_username: string
  User's preferred name
• sub: string
  Subject provided by the user
• website: string
  Website provided by the user

{
    "description":"Generate the user information in JSON format.",
    "type":"object",
    "properties":{
        "birthdate":{
            "type":"string",
            "description":"Birthdate of the user"
        },
        "family_name":{
            "type":"string",
            "description":"Family name of the user"
        },
        "gender":{
            "type":"string",
            "description":"Gender of the user"
        },
        "given_name":{
            "type":"string",
            "description":"First name of the user"
        },
        "name":{
            "type":"string",
            "description":"Name of the user"
        },
        "preferred_username":{
            "type":"string",
            "description":"User's preferred name "
        },
        "sub":{
            "type":"string",
            "description":"Subject provided by the user"
        },
        "website":{
            "type":"string",
            "description":"Website provided by the user"
        }
    },
    "required":[
        "birthdate",
        "family_name",
        "gender",
        "given_name",
        "name",
        "preferred_username",
        "sub",
        "website"
    ]
}

400 Response

Invalid request

Body ()

Root Schema : error

Type: object

Error message that appears during Access Token generation

Show Source

• error: string
  Error values that are based on the OAuth specification
• error_description: string
  Detailed error messages

{
    "description":"Error message that appears during Access Token generation",
    "type":"object",
    "properties":{
        "error":{
            "type":"string",
            "description":"Error values that are based on the OAuth specification"
        },
        "error_description":{
            "type":"string",
            "description":"Detailed error messages"
        }
    },
    "required":[
        "error",
        "error_description"
    ]
}

Back to Top