Headers

• x-fapi-auth-date string

  The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

  Format should match the following pattern: ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$.

• x-fapi-customer-ip-address string

  The PSU's IP address if the PSU is currently logged in with the TPP.

• x-fapi-interaction-id string

  An RFC4122 UID used as a correlation id.

• x-customer-user-agent string

  Indicates the user-agent that the PSU is using.

Path parameters

• OrganisationId string Required

  The organisation ID

  Minimum length is 1, maximum length is 40. Format should match the following pattern: ^[^<>]*$.

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

• containsOpenIdDiscoveryDocument boolean

  Filter responses by whether they contain an Open ID Discovery Document

• omitFromEcosystem boolean

  Filter responses to those whose 'OmitFromEcosystem' matches the input

• status string

  Filter responses by status

  Values are Active or Inactive. Default value is Active.

• filterBy string

  Query by CustomerFriendlyName or AuthorisationServerId that contain the given string, case insensitive

Responses

• 200 application/json

  All authorisation servers for the org

  Hide headers attribute Show 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 Show response attributes object

  • 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 Required

    Flag to denote if this authorisation server supports the automatic onboarding of software statement clients

    Default value is false.

  • CustomerFriendlyDescription string Required

    A customer friendly description

    Minimum length is 1, maximum length is 255. Format should match the following pattern: ^[^<>]*$.

  • CustomerFriendlyLogoUri string(uri) Required

    A compliant URI

    Format should match the following pattern: ^(http://|https://).*.(svg|png|jpg|jpeg)$|(data:image/[a-zA-Z0-9;+=-]+,[A-Za-z0-9+/]*={0,2})$.

  • CustomerFriendlyName string Required

    Minimum length is 1, maximum length is 255. Format should match the following pattern: ^[^<>]*$.

  • DeprecatedDate string(date)

    Authorisation Server support/deprecation end date

  • DeveloperPortalUri string(uri) | null

    A compliant URI

    Maximum length is 255. Format should match the following pattern: ^(http://|https://).*.

  • FederationId string(uuid)

    The ID of the federation

    Maximum length is 36.

  • NotificationWebhook string(uri)

    A compliant URI

    Maximum length is 255. Format should match the following pattern: ^(http://|https://).*.

  • OmitFromEcosystem boolean

    'Denotes if the entity should be omitted from the subject ecosystem. For example, an authorisation server with this flag set to true would not appear in the participants endpoint or OpenID Federation offerings'

    Default value is false.

  • OpenIDDiscoveryDocument string

    A compliant URI

    Maximum length is 255. Format should match the following pattern: ^(http://|https://).*.

  • ParentAuthorisationServerId string(uuid)

    Maximum length is 40. Format should match the following pattern: ^[^<>]*$.

  • PayloadSigningCertLocationUri string

    A compliant URI

    Maximum length is 255. Format should match the following pattern: ^(http://|https://).*.

  • RetirementDate string(date)

    Authorisation Server Retirement date

  • SupersededByAuthorisationServerId string(uuid)

    Authorisation Server ID which replaces the current auth server

    Maximum length is 40. Format should match the following pattern: ^[^<>]*$.

  • TermsOfServiceUri string(uri) | null

    A compliant URI

    Maximum length is 255. Format should match the following pattern: ^(http://|https://).*.

  • AuthorisationServerId string(uuid)

    Maximum length is 40. Format should match the following pattern: ^[^<>]*$.

  • CreatedAt string(date-time)
  • FederationEndpoint string(uri)

    The federation endpoint for the Authorisation Server

    Maximum length is 255. Format should match the following pattern: ^(https://).*.

  • Issuer string(uri)

    An issuer value pulled from the well-known endpoint

  • NotificationWebhookAddedDate string(date)

    Creation date

  • NotificationWebhookStatus string

    Values are Pending, Confirmed, or Deactivated. Default value is Pending.

  • OrganisationId string Deprecated

    Unique ID associated with the organisation

    Minimum length is 1, maximum length is 40. Format should match the following pattern: ^[^<>]*$.

  • 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.

  • ApiResources array[object]
    Hide ApiResources attributes Show ApiResources attributes object

    • ApiDiscoveryEndpoints array[object]
      Hide ApiDiscoveryEndpoints attributes Show ApiDiscoveryEndpoints attributes object

      • ApiDiscoveryId string

        The unique ID of an Api discovery endpoint resource

        Maximum length is 40. Format should match the following pattern: ^[^<>]*$.

      • ApiEndpoint string

        A compliant URI

        Maximum length is 255. Format should match the following pattern: ^(http://|https://).*.

    • ApiMetadata object
    • ApiCertificationUri string(uri)

      Link to the certifation package. Example https://github.com/Open[Domain]/conformance/blob/main/submissions/functional/business/1.0.3/api-business-customer.zip

      Maximum length is 500. Format should match the following pattern: ^(https://).*.

    • ApiFamilyType string

      The type of API this record describes

      Minimum length is 1, maximum length is 128. Format should match the following pattern: ^[^<>]*$.

    • ApiResourceId string

      The unique ID of an Api version resource

      Maximum length is 40. Format should match the following pattern: ^[^<>]*$.

    • ApiVersion string

      The version number of the API

      Format should match the following pattern: ^([0-9]+\.[0-9]+\.[0-9]+)$|^([0-9]+)$|^([0-9]+\.[0-9]+)$.

    • CertificationExpirationDate string

      JSONDatetime of certification expiration date

      Format should match the following pattern: ^[^<>]*$.

    • CertificationStartDate string

      JSONDatetime of certification start date

      Format should match the following pattern: ^[0-3][0-9]/[0-1][0-9]/2([0-9]{3})$.

    • CertificationStatus string

      The different types of certification status

      Values are Awaiting Certification, Certified, Deprecated, Rejected, Warning, or Self-Certified. Default value is Awaiting Certification.

    • FamilyComplete boolean

      Denotes whether or not the api resource has had all related api endpoints published

    • Status string

      Current status of this resource

      Values are Active or Inactive. Default value is Active.

  • AuthorisationServerCertifications array[object]
    Hide AuthorisationServerCertifications attributes Show AuthorisationServerCertifications attributes object

    • AuthorisationServerId string(uuid)

      Maximum length is 40. Format should match the following pattern: ^[^<>]*$.

    • CertificationExpirationDate string

      JSONDatetime of certification expiration date

      Format should match the following pattern: ^[^<>]*$.

    • CertificationId string

      Unique ID associated with the auth server certification

      Minimum length is 1, maximum length is 40. Format should match the following pattern: ^[^<>]*$.

    • CertificationStartDate string

      JSONDatetime of certification start date

      Format should match the following pattern: ^[0-3][0-9]/[0-1][0-9]/2([0-9]{3})$.

    • CertificationStatus string

      The different types of certification status

      Values are Awaiting Certification, Certified, Deprecated, Rejected, Warning, or Self-Certified. Default value is Awaiting Certification.

    • CertificationURI string(uri)

      Link to the certifation package. Example https://github.com/Open[Domain]/conformance/blob/main/submissions/functional/business/1.0.3/api-business-customer.zip

      Maximum length is 500. Format should match the following pattern: ^(https://).*.

    • ProfileType string

      Certification type

      Format should match the following pattern: ^[^<>]*$.

    • ProfileVariant string

      Certification variant

      Format should match the following pattern: ^[^<>]*$.

    • ProfileVersion number

      The version number of the certification

    • Status string

      Current status of this resource

      Values are Active or Inactive. Default value is Active.

  • Flags array[object]
    Hide Flags attributes Show Flags attributes object

    • CreatedAt string(date-time)
    • Id string

      Unique ID of the flag

      Maximum length is 40. Format should match the following pattern: ^[^<>]*$.

    • UpdatedAt string(date-time)
    • AccessLevel integer Required

      The access level of a flag as a number. The higher the number, the more sensitive it is

    • Description string

      The description of this flag

      Maximum length is 255. Format should match the following pattern: ^[^<>]*$.

    • Name string Required

      The name of this flag

      Maximum length is 255. Format should match the following pattern: ^[^<>]*$.

    • Status string Required

      Current status of this resource

      Values are Active or Inactive. Default value is Active.

    • Type string Required

      The type of this tag

      Values are Organisation, Software_Statement, or Authorisation_Server.

    • Value string Required

      The value of this flag

      Maximum length is 255. Format should match the following pattern: ^[^<>]*$.

  • Status string

    Current status of this resource

    Values are Active or Inactive. Default value is Active.

• 401

  Unauthorized

  Hide headers attribute Show 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}$.

• 403

  Forbidden

  Hide headers attribute Show 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}$.

• 429

  Too many requests, maximum capacity reached. Requests are now throttled.

  Hide headers attribute Show 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}$.

• 500

  Internal Server Error

  Hide headers attribute Show 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}$.

• 502

  Bad Gateway

  Hide headers attribute Show 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}$.

• 504

  Upstream timeout, insufficient capacity to serve request. More capacity being brought online. Please try again.

  Hide headers attribute Show 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}$.