Query parameters

• page integer

  The page number to return of the result set

• size integer

  The size of the pages to return

Responses

• 200 application/json

  Paged data of federations

  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

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

    • Contacts array[string]

      The contacts of the federation

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

    • CreatedAt string(date-time)
    • Description string

      The description of the federation

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

    • FederationFetchEndpoint string(uri)

      The fetch endpoint of the federation

      Maximum length is 255.

    • FederationListEndpoint string(uri)

      The list endpoint of the federation

      Maximum length is 255.

    • FederationResolveEndpoint string(uri)

      The resolve endpoint of the federation

      Maximum length is 255.

    • FederationTrustMarkListEndpoint string(uri)

      The trust mark list endpoint of the federation

      Maximum length is 255.

    • FederationTrustMarkStatusEndpoint string(uri)

      The trust mark status endpoint of the federation

      Maximum length is 255.

    • HomepageUri string

      The homepage uri of the federation

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

    • LogoUri string

      The logo uri of the federation

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

    • Name string

      The name of the federation

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

    • OrganizationName string

      The organization name of the federation

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

    • PolicyUri string

      The policy uri of the federation

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

    • ReferenceID string(uuid)

      The ID of the federation

    • RemoteTrustAnchor string(uri)

      The uri for a remote trust anchor

      Maximum length is 255.

    • Status string

      Current status of this resource

      Values are Active or Inactive. Default value is Active.

  • empty boolean
  • numberOfElements integer
  • offset integer
  • pageNumber integer
  • pageable object
    Hide pageable attributes Show pageable attributes object

    • mode string

      Pageable mode. Possible values are OFFSET, CURSOR_NEXT, CURSOR_PREVIOUS

    • number integer

      Page number

    • offset integer

      Offset

    • size integer

      Size of the page

    • sort object
      Hide sort attributes Show sort attributes object

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

        • ascending boolean

          Whether ascending

        • direction string

          Direction of sort, i.e. ascending or descending

          Values are ASC or DESC.

        • ignoreCase boolean

          Was the case ignored

        • property string

          Name of the property used for sorting

      • sorted boolean
    • sorted boolean

      Is the page sorted

    • unpaged boolean

      Is this an unpaged response

  • size integer
  • totalPages integer
  • totalSize integer
• 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}$.

• 404 application/json

  Not found

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

  • errors array[string]

    Validation Error messages

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