Authority
  • Introduction
  • In Action
  • Performance at Scale
  • Roadmap / Features
  • Getting Started
    • Introduction
    • Installation
    • Configuration Overview
  • Authentication
    • Authentication Guide
    • API Documentation
    • Customizing Authentication
  • Security & Error Handling
    • Security Considerations
    • Error Handling & Troubleshooting
  • Providers
    • Client Providers
    • Owner Providers
  • API Endpoints
    • API Endpoints
  • DEVELOPMENT
    • Requirements
    • Database
    • User Interface
    • Specs
    • Deployment
      • Environment Variables
  • Reference
    • OAuth Terms
    • OAuth 2 Grant Flows
      • Device Flow
      • Authorization Flow
      • Client Credentials Flow
      • Refreshing Access Tokens
      • Access Token Response
      • Json Web Tokens
      • Legacy: Implicit grant
      • Legacy: Password
    • Open ID Connect
      • Configuration
      • Registering Clients
      • User Info
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. Reference
  2. Open ID Connect

User Info

PreviousRegistering Clients

Last updated 3 years ago

Was this helpful?

  • GETGet claims about the authenticated End-User
  • POSTGet claims about the authenticated End-User

Get claims about the authenticated End-User

get

The UserInfo Endpoint is an OAuth 2.0 Protected Resource that returns Claims about the authenticated End-User.

Header parameters
AuthorizationstringRequired

To obtain the requested Claims about the End-User, the Client makes a request to the UserInfo Endpoint using an Access Token obtained through OpenID Connect Authentication

Responses
200
Claims about the authenticated End-User
application/json
400
Invalid Request
401
Invalid Token
get
GET /unknown/userinfo HTTP/1.1
Host: auth.authority.io
Authorization: text
Accept: */*

{
  "sub": "text",
  "name": "text",
  "given_name": "text",
  "family_name": "text",
  "middle_name": "text",
  "nickname": "text",
  "preferred_username": "text",
  "profile": "text",
  "picture": "text",
  "website": "text",
  "email": "text",
  "email_verified": true,
  "gender": "text",
  "birthdate": "text",
  "zoneinfo": "text",
  "locale": "text",
  "phone_number": "text",
  "phone_number_verified": true,
  "address": "text",
  "updated_at": 1
}

Get claims about the authenticated End-User

post

The UserInfo Endpoint is an OAuth 2.0 Protected Resource that returns Claims about the authenticated End-User.

Body
access_tokenstringRequired

To obtain the requested Claims about the End-User, the Client makes a request to the UserInfo Endpoint using an Access Token obtained through OpenID Connect Authentication

Responses
200
Claims about the authenticated End-User
application/json
400
Invalid Request
401
Invalid Token
post
POST /unknown/userinfo HTTP/1.1
Host: auth.authority.io
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 23

"access_token='text'"
{
  "sub": "text",
  "name": "text",
  "given_name": "text",
  "family_name": "text",
  "middle_name": "text",
  "nickname": "text",
  "preferred_username": "text",
  "profile": "text",
  "picture": "text",
  "website": "text",
  "email": "text",
  "email_verified": true,
  "gender": "text",
  "birthdate": "text",
  "zoneinfo": "text",
  "locale": "text",
  "phone_number": "text",
  "phone_number_verified": true,
  "address": "text",
  "updated_at": 1
}