---
id: get-post-oidc-auth
title: "UserInfo Endpoint"
description: "OpenID Connect UserInfo endpoint that returns claims about the authenticated end-user. Requires a valid access token obtained from the token endpoint to be provided in the `Authorization` header."
sidebar_label: "UserInfo Endpoint"
hide_title: true
hide_table_of_contents: true
api: eJzlV81u20YQfpXBnGyAphTHvRBB0MROC/UvRpygB9eAR+SI3Hi5y+wuJSsCb32SPlqfpJgl9WNJaXpufDG53Jmd+Wb2+0YrLNjnTjVBWYMZvm3YTK7g0hrDeYAPnt3EzCywKRqrTIBQUQDHoXXGQ65J1R5oalv5wkBtqNgElVPgQozOWs8uhXf8qVWOPRDMSasCKM/Zewj2gQ3YaSBluICZs3X0069vD7UwZWicnauCC1Ambrp/1YbKOvWZJPh7qJgKdukfBhNsyFHNgZ3H7Ha1l+T7imFyBXYW3VhXklE+OsEElexoKFSYoKGaMcPdHZMCE3R9OgVmwbWcoM8rrgmzFYZlIxY+OGVK7Lo72ewbazx7+X4+Hsu/p/EIyqDMzLp6HUVuTWATZC81jRZAlTWjj14MVocH2ulHzoMk7mzDLqj+ON9OD6NK9o836lPLoAqp3Eyxg5l1ERopHnbilD2b0Ad35FAqCiXfSF/vHN9js9df0QQkPVJGmTKeEZOHk76dTrGTvwT7ekoe8nYxfiZH/2dgtjW6RXbOuktbMCb989VOUHfJV0DcWm9TVyZwyU78PVLdaMbsYjzujrg/Av/GBF+TdHPTBtg07Dr7/RrR0OwsDbgPzcU3DM079rZ1OYOxAWa2NYcAfdffum8UoIkJ7Axp8Ozm7CAes4dRl6DnvHUqLCNhvmZy7IRgMbu9ExqTrNYMmGHJ4dr68HZydRk3JRioFK5dK8h1T9YOTn4l4Ws2ZMKpAFZzqKz4aKyPgAnXZjiaPx9JgCrnET8GNl5qY1WRj1ZPCbgbCWcIZaBELTkdY/krru2QMibYOo0ZViE0PhuNCq7tGTUqVaUjE1JlsUv2HVw7W7S5vHzJzdc83AQqheO+YO77z/uB3G1rcSMt2XfSq0b9zMudlqB+YVCsvphbzXqijQeU/+p6Ag+83NVrZU0Kooxz0i2vxfG4xkLd+tBLMs/UIxewUKGC+z5GuIcTYwP3Su5I6YhBQzmfJsBpme65zWAwfLG0rRM4zh54+fI+Fe3Z7cQVTuPbD1EpMcOffn9/mNvuaNGQ9+vwek9DzDJEPAkCNghGHhAM+8Nwc8elbihXJfbeQCiUR0LhmpTU1rdNY134flvPTUnUj9ulp42w20N72WyM4OTvP/86BSUz1M2CC+UrKCgQ8GNekSkZyBQwZ6dmQzlhuE7rwcmlMAmitx4869mZt3N2rEozSH9YJoM9TTVD7jguk/YJEBSqVIE0LEhrDvEwb2WUa2wBgfPKWG1LxT4BNjSNNScwvADNc9bSUEJ8kR1pqrQKy+iE2mBl7DEl5LZutCKTc1+wmJ7jstUxHy81I5i1WkvnFirEOGsyhl2KCWqVs/GRate3oKG8YjhPxweYLxaLlOLn1LpyNNj60S+Tyze/3bw5E5suwaCCflI8kLtT2LytNxNRgkJBfb3Ox+cX6fP0WRybrA81mZ14NvP0m2G03e/eHZH638ziw+0J/BhGjSZlBJtYjNVA/rc4fz5wucqj0K4FABMUCcAEs4MpfKMCdwlWoiXZLa5WU/L8wemuk+VPLTsRtLsE5+RiX/dKobw8F5jNSPv9KXW3CCcDXMUp/OvPhqNJrpnaCE1HXsUMMcEHIfL9nxXd3WbmjTH2m4TNmrBjfjC5dLuaev32RhiRBrocAtgQ2fAg7o/G9mLgyPdS85ebSGMLSIBd9w+v1PvQ
sidebar_class_name: "post api-method"
info_path: docs/extensions-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>UserInfo Endpoint</h1>

<MethodEndpoint method={"post"} path={"/v3/service/extension/oidc/{organisationId}/userinfo"}></MethodEndpoint>



OpenID Connect UserInfo endpoint that returns claims about the authenticated end-user. Requires a valid access token obtained from the token endpoint to be provided in the `Authorization` header.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"The ID of the organisation","in":"path","name":"organisationId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

User information

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"sub"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique identifier for the user"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentation</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Object containing user info (claims)

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true,"description":"Object containing user info (claims)"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"sub\": \"string\",\n  \"presentation\": {}\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>