Skip to main content

Get all Api Discovery Endpoints for the given Authorisation Server and Api Version

GET 
/organisations/:OrganisationId/authorisationservers/:AuthorisationServerId/apiresources/:ApiResourceId/apidiscoveryendpoints

get all api discovery endpoints listed for a specific api resource

Request​

Path Parameters

    OrganisationId OrganisationIdrequired

    Possible values: non-empty and <= 40 characters, Value must match regular expression ^[^<>]*$

    The organisation ID

    AuthorisationServerId AuthorisationServerIdrequired

    Possible values: <= 40 characters, Value must match regular expression ^[^<>]*$

    The authorisation server Id

    ApiResourceId ApiResourceIdrequired

    Possible values: <= 40 characters, Value must match regular expression ^[^<>]*$

    The api version Id

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

Header Parameters

    x-fapi-auth-date string

    Possible values: Value must match regular expression ^(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)$

    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

    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.

Responses​

Authorisation server response

Response Headers

  • x-fapi-interaction-id

    string

Schema

  • Array [

    • ApiDiscoveryId ApiEndpointId (string)

    Possible values: <= 40 characters, Value must match regular expression ^[^<>]*$

    The unique ID of an Api discovery endpoint resource

    ApiEndpoint ApiEndpoint (string)

    Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

    A compliant URI

  • ]

Loading...