How-Tos
Organisations
Find Specific Data Provider
if you want to read more about the data providers, please take a look data providers docid\ apm ilivcfpfft1ld0puc note for open ecosystems a public api is available with information of all data providers see information find data providers via public api docid\ noxrarloe3g7a 5jnpbed goal you will be able to find all data providers in the directory requirements have an active and valid software statement created on your organisation see how to publish one data receiver docid\ wqup7q4hedkp6j2fm4o3r have an active transport certificate to your organisations see how to get one certificates docid\ wfkffamcnvbnl5i0kahir have extracted all organisationids from the directory see how to do it get information on all organisations docid\ n5zgb9zkury4 rrqep79k example request for each organisationid, extract all authorisation servers calling the following endpoint curl \\ x get https //host/organisations/{organisationid}/authorisationservers \\ h "authorization $api key"# headers x fapi interaction id 73cac523 d3ae 2289 b106 330a6218710d \# payload { "errors" \[ "string" ] } get all authorisation servers for the given organisation get /organisations/{organisationid}/authorisationservers authorizer oauth query parameters page integer the page number to return of the result set size integer the size of the pages to return sort string the field name to sort responses • 200 application/json all authorisation servers for the org hide headers attribute x fapi interaction id string an rfc4122 uid used as a correlation id minimum length is 1, maximum length is 100 format should match the following pattern ^\[a za z0 9]\[a za z0 9\\ ]{0,99}$ hide response attributes object apiresources array\[object] show apiresources attributes object authorisationservercertifications array\[object] show authorisationservercertifications attributes object authorisationserverid string maximum length is 40 autoregistrationnotificationwebhook string(uri) a compliant uri to subscribe to the software statement onboarding webhook maximum length is 255 format should match the following pattern ^(http //|https //) autoregistrationsupported boolean flag to denote if this authorisation server supports the automatic onboarding of software statement clients default value is false createdat string(date time) customerfriendlydescription string maximum length is 255 customerfriendlylogouri string(uri) a compliant uri maximum length is 255 format should match the following pattern ^(http //|https //) (svg|png|jpg|jpeg)$ customerfriendlyname string maximum length is 255 deprecateddate string(date) authorisation server support/deprecation end date developerportaluri string(uri) a compliant uri maximum length is 255 format should match the following pattern ^(http //|https //) federationendpoint string(uri) the federation endpoint for the authorisation server maximum length is 255 format should match the following pattern ^(https //) federationid string(uuid) the id of the federation maximum length is 36 issuer string(uri) an issuer value pulled from the well known endpoint notificationwebhook string(uri) a compliant uri maximum length is 255 format should match the following pattern ^(http //|https //) notificationwebhookaddeddate string(date) creation date notificationwebhookstatus string values are pending, confirmed, or deactivated default value is pending openiddiscoverydocument string(uri) a compliant uri maximum length is 255 format should match the following pattern ^(http //|https //) organisationid string unique id associated with the organisation minimum length is 1, maximum length is 40 parentauthorisationserverid string maximum length is 40 payloadsigningcertlocationuri string(uri) a compliant uri maximum length is 255 format should match the following pattern ^(http //|https //) retirementdate string(date) authorisation server retirement date supersededbyauthorisationserverid string authorisation server id which replaces the current auth server maximum length is 40 supportsciba boolean flag to denote if this authorisation server supports client initiated backchannel authentication default value is false supportsdcr boolean flag to denote if this authorisation server supports dynamic client registration default value is false supportsredirect boolean flag to denote if this authorisation server supports redirect default value is false termsofserviceuri string(uri) a compliant uri maximum length is 255 format should match the following pattern ^(http //|https //) • 401 unauthorized show headers attribute • 403 forbidden show headers attribute • 429 too many requests, maximum capacity reached requests are now throttled show headers attribute • 500 internal server error show headers attribute • 502 bad gateway show headers attribute • 504 upstream timeout, insufficient capacity to serve request more capacity being brought online please try again show headers attribute get /organisations/{organisationid}/authorisationservers curl \\ x get https //matls api sandbox raidiam io/organisations/{organisationid}/authorisationservers \\ h "authorization $api key" response examples (200) \# headers x fapi interaction id 73cac523 d3ae 2289 b106 330a6218710d \# payload \[ { "apiresources" \[ { "apidiscoveryendpoints" \[ { "apidiscoveryid" "string", "apiendpoint" "https //raidiam io/cb" } ], "apicertificationuri" "https //example com", "apifamilytype" "string", "apiresourceid" "string", "apiversion" "string", "certificationexpirationdate" "string", "certificationstartdate" "string", "certificationstatus" "awaiting certification", "familycomplete" true } ], "authorisationservercertifications" \[ { "authorisationserverid" "string", "certificationexpirationdate" "string", "certificationid" "string", "certificationstartdate" "string", "certificationuri" "https //example com", "profiletype" "redirect", "profilevariant" "fapi adv op w/ mtls", "profileversion" 42 0, "status" "awaiting certification" } ], "authorisationserverid" "string", "autoregistrationnotificationwebhook" "https //example com", "autoregistrationsupported" false, "createdat" "2023 05 04t09 42 00+00 00", "customerfriendlydescription" "string", "customerfriendlylogouri" "https //example com", "customerfriendlyname" "string", "deprecateddate" "2021 01 30", "developerportaluri" "https //example com", "federationendpoint" "https //example com", "federationid" "string", "issuer" "https //example com", "notificationwebhook" "https //example com", "notificationwebhookaddeddate" "2021 01 30", "notificationwebhookstatus" "pending", "openiddiscoverydocument" "https //example com", "organisationid" "string", "parentauthorisationserverid" "string", "payloadsigningcertlocationuri" "https //example com", "retirementdate" "2023 12 30", "supersededbyauthorisationserverid" "f81d4fae 7dec 11d0 a765 00a0c91e6bf6", "supportsciba" false, "supportsdcr" false, "supportsredirect" false, "termsofserviceuri" "https //example com" } ]