Taifa Identity. Docs
OpenAPI Developers

API reference

Institutions

Management API contract View .md

GET/v1/institutions

Authentication Bearer access token with audience taifa-management. Roles and local eligibility are reviewed separately from the OpenAPI bearer scheme.

Parameters

No path or query parameters declared.

Request body

This operation has no request body.

Responses

200Successful Response

Content type: application/json(InstitutionForOperator | InstitutionForAdministrator)[]

Required applies within each listed response variant.

FieldVariantTypeRequiredDescription
[].idInstitutionForOperatorstringYes
[].nameInstitutionForOperatorstringYes
[].statusInstitutionForOperatorstringYes
[].proposerInstitutionForOperatorstringYes
[].approverInstitutionForOperatorstring | nullYes
[].evidence_referenceInstitutionForOperatorstringYes
[].can_review_evidenceInstitutionForOperatortrueYes
[].idInstitutionForAdministratorstringYes
[].nameInstitutionForAdministratorstringYes
[].statusInstitutionForAdministratorstringYes
[].proposerInstitutionForAdministratorstringYes
[].approverInstitutionForAdministratorstring | nullYes
[].can_review_evidenceInstitutionForAdministratorfalseYes

Request example

Illustrative only. TypeScript runs in Node.js on the server. Keep management tokens out of browser bundles. Replace the host, token, path values, and any header or required body placeholders before use. Examples do not send requests.

Shell
curl -X GET 'https://YOUR_IDENTITY_HOST/v1/institutions' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response example

No response example in the current specification.

Popular

Browse by section