Skip to main content

Get all federations

GET 
/references/federations

get all federations

Request​

Query Parameters

    page integer

    The page number to return of the result set

    size integer

    The size of the pages to return

Responses​

Paged data of federations

Response Headers

  • x-fapi-interaction-id

    string

Schema

    content

    object[]

  • Array [

    • ReferenceID uuid

    Possible values: <= 36 characters

    The ID of the federation

    Name FederationName (string)

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

    The name of the federation

    Description FederationDescription (string)

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

    The description of the federation

    FederationFetchEndpoint uri

    Possible values: <= 255 characters

    The fetch endpoint of the federation

    FederationListEndpoint uri

    Possible values: <= 255 characters

    The list endpoint of the federation

    FederationResolveEndpoint uri

    Possible values: <= 255 characters

    The resolve endpoint of the federation

    FederationTrustMarkStatusEndpoint uri

    Possible values: <= 255 characters

    The trust mark status endpoint of the federation

    FederationTrustMarkListEndpoint uri

    Possible values: <= 255 characters

    The trust mark list endpoint of the federation

    OrganizationName FederationOrganizationName (string)

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

    The organization name of the federation

    Contacts FederationContact (string)[]

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

    The contacts of the federation

    LogoUri FederationLogoUri (string)

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

    The logo uri of the federation

    PolicyUri FederationPolicyUri (string)

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

    The policy uri of the federation

    HomepageUri FederationHomepageUri (string)

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

    The homepage uri of the federation

    CreatedAt date-time
    Status StatusEnum (string)

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

    RemoteTrustAnchor uri

    Possible values: <= 255 characters

    The uri for a remote trust anchor

  • ]

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