Read organisation
GET/service/organisation
This endpoint is used to read the organisation information as configured by the organisation in the consent building block. This is used, for e.g., in the privacy dashboard.
Request
Header Parameters
organizationId stringrequired
Unique ID of an organisation
Responses
- 200
- 401
- 500
OK
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
organisation object[]required
{
"organisation": [
{
"id": "string",
"name": "string",
"description": "string",
"sector": "string",
"location": "string",
"policyUrl": "string",
"authentication": {
"password": {
"enabled": true
},
"oidcPasswordless": {
"enabled": true,
"presentationDefinitionId": "string"
}
},
"coverImageId": "string",
"coverImageUrl": "string",
"logoImageId": "string",
"logoImageUrl": "string"
}
]
}
Unauthorized
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
errorCode integerrequired
errorDescription stringrequired
{
"errorCode": 400,
"errorDescription": "Bad input parameter"
}
Internal server error
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
errorCode integerrequired
errorDescription stringrequired
{
"errorCode": 400,
"errorDescription": "Bad input parameter"
}
Loading...