---
id: service-read-idp
title: "Read IdP details"
description: "This endpoint is used to read the IdP details configured by the organisation in the consent building block."
sidebar_label: "Read IdP details"
hide_title: true
hide_table_of_contents: true
api: eJzdVs1uGzcQfpUBTwmwWjluehGCoE6cBmqCwohj9BAI8Gg52mXMJRmSK1kR9tYn6aP1SYrhrqTVj1Hk0kMv9oqcGX7z981shKRQeOWiskZMxOdKBSAjnVUmggrQBJIQLXhCCbEimMobkBRR6QCFNQtVNp4kzNfp1voSjQrI5kCZdFZYE8hEmDdKS2VKmGtbPOQiE9aRT6JTKSYikF+qgj4Ryql0IhMOPdYUyQcx+bI5Qnpn1LeGYHoNdgFowM6/UhFFJhTfOoyVyITBmsREKOmmUmTC07dGeZJiEn1DmQhFRTWKyUbEtWPBEL0ypWjbGQsHx8gD319eXPC/wppIJvInOqdVkdCPvwaGtBnYc559i6rTVtINHtkhfRwZG0fKjCRGnGMgMVmgDjQE+kUoRq5taZt457XIRKEVmTiVYpadvHPqSyYW1tcYxUSITNAj1k5T9+MwoNPrG5hei3b42Blrh0ofkyiwbDtA9q96b5Nkeq9t2+woNOnoCJ28AU/RK1qShNAUBYWwaLRei0xUhDJVyYYVX3a5OtSfowRlXBNhV1VnFF/8UJKHWSLvrX9rJXGQ+ft68Pzs2MHjxO2195FTJlKZUO6S9vLioj1j/ky093l+c8bxtj0T4TuDTaysV99JnoTm5x+s//9XaKYmkjeogSmKPKRnjmLUZiJQ0XgV14mtrpz6QPw5a7ONeEPoyV81sUon7DWWTGtiKslEFddw4+1SSfIckppiZZkTS0oRYTabiHHPkGMl3dg6MqPEDR2ocxx5TbXtMYtMNNzQoorRhcl4LKm2I3QqV6VHE3Nlx8tLwVgPbdxGLJm0nzATuuszlmb7gNxyXXTp3IZllxfsDnre7iK6Z+6rviRTnZ2wyNXNFB5oDVy4HMWuHHP4XBEsUTfEs4FH0P2BnXvonoG6CRHmBM7TQj2ShJWKFdx3GOEenhkbKRmIHpVOYXBY0PMMKC/zI7MT6BVfrW3jOSKjB1q/vs+ZGocFsBHz9OvXLTH/9sfnU98Sw0G0D2TAYQhbeJ2lHjPP2AMQsItgakaOYfeY2DUap05wvSqzsNuuxiJ1NdWoOL2hcc76+MsupYNh+n5/dFgLe+GTDtopwbO///zrOW8WCLcrkipUwOMP6LGo0JQEaCQsyatFn07oqx5c3yA5TCPvJQEC6cUo2CV5UqUB1bdS1uvjXBMUntIx6pABglSliqhhhVpTTI8Fq5UEZyVEKipjtS0VhQzI4DzlHMHQCjQtSXNBMfskisK50ty5bASbaGuMLF7Y2mmFpqAuYck9T2Wjkz+Bc4aQZhdgI1VMOGs0hjxvRVoVZELiu20XOCwqgsv84iTmq9Uqx3SdW1+Oe90w/jh9++7323cj1uH5qqI+SB5w70hbNDWZuO0uppEuX5cXly/zn/IXrOtsiDWaAR5e0YaL4HHxDgbFf7xR9iUe6TGOnUZl2IGm22Q6Fv2y3TOZctKauWXSWSYqGyKLbDa8jt153bZ8/K0hn6g8E0v0qa46tlWBv+Vub3syCs8+9QPxOTy5uJ7FvmVJwxSZOK3b3R6YRPvFtp2121mUYHV3TCAuDrROJnY7nDTv3zEHYU9Qe3J+SOTcf7D1s4iOebqDwH95opxVecUV+IHWr3fi3c2TCjtm631nB9q2/Qd1tGmn
sidebar_class_name: "get api-method"
info_path: docs/consent-management-individual-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"}>Read IdP details</h1>

<MethodEndpoint method={"get"} path={"/service/idp/open-id"}></MethodEndpoint>



This endpoint is used to read the IdP details configured by the organisation in the consent building block.

## 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":"Unique ID of an object","in":"path","name":"idpId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

IdP retrieved successfully

</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={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>idp</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"IDP ID"}}></SchemaItem><SchemaItem collapsible={false} name={"logoutUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Logout Url"}}></SchemaItem><SchemaItem collapsible={false} name={"clientId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Client ID"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"idp\": {\n    \"id\": \"\",\n    \"logoutUrl\": \"string\",\n    \"clientId\": \"string\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</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></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={"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>