Skip to main content

Get all authorisation server federation configuration by Authorisation Server Id

GET 
/organisations/:OrganisationId/authorisationservers/:AuthorisationServerId/federation

get all federation configuration for a given authorisation server

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

Query Parameters

    policyStatus PolicyApprovalStatusEnum

    Possible values: Value must match regular expression ^[^<>]*$, [active, assignable, pending, rejected]

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​

Paged data of auth server federations config

Response Headers

  • x-fapi-interaction-id

    string

Schema

    content

    object[]

  • Array [

    • FederationConfigId FederationConfigId (string)

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

    Unique Federation Configuration Id

    AuthorisationServerId AuthorisationServerId (string)

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

    ConfigJson ConfigJson (string)

    Possible values: Value must match regular expression ^[^<>]*$

    JSON containing all Federation Configurations

    Version FederationVersion (integer)

    Version number of the Federation configuration

    Status PolicyApprovalStatusEnum (string)

    Possible values: Value must match regular expression ^[^<>]*$, [active, assignable, pending, rejected]

    The status of the policy

  • ]

    • totalPages integer
    totalSize integer

    pageable

    object

    number integer

    Page number

    sort

    object

    sorted boolean

    orderBy

    object[]

  • Array [

    • property string

    Name of the property used for sorting

    direction string

    Possible values: [ASC, DESC]

    Direction of sort, i.e. ascending or descending

    ignoreCase boolean

    Was the case ignored

    ascending boolean

    Whether ascending

  • ]

    • size integer

    Size of the page

    offset integer

    Offset

    sorted boolean

    Is the page sorted

    unpaged boolean

    Is this an unpaged response

    numberOfElements integer
    size integer
    offset integer
    empty boolean
    pageNumber integer
Loading...