Get the metadata policy for a federation

GET 
/references/federations/:FederationId/metadata-policy

get the metadata policy for a federation

Request

Path Parameters

FederationId uuidrequired

Possible values: <= 36 characters

The federation id

Query Parameters

type MetadataPolicyTypeEnum

Possible values: Value must match regular expression ^[^<>]*$, [openid_relying_party, openid_provider, oauth_authorization_server, oauth_client, oauth_resource, federation_entity]

The metadata policy type

policyStatus PolicyApprovalStatusEnum

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

version MetadataPolicyVersion

The metadata policy version. Providing a value of '0' returns the latest version

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

Responses

200

Paged data of federation metadata policies

Response Headers

• x-fapi-interaction-id

  string

application/json

Schema

Schema

content

object[]

Array [

ReferenceID MetadataPolicyId (string)

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

The id of the metadata policy

FederationID uuid

Possible values: <= 36 characters

The ID of the federation

Type MetadataPolicyTypeEnum (string)

Possible values: Value must match regular expression ^[^<>]*$, [openid_relying_party, openid_provider, oauth_authorization_server, oauth_client, oauth_resource, federation_entity]

The type of the metadata policy

Version MetadataPolicyVersion (integer)

The version of the metadata policy

Policy MetadataPolicyJson (string)

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

The json of the metadata policy

Status PolicyApprovalStatusEnum (string)

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

The status of the policy

CreatedAt date-time

]

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

Example (from schema)

{
  "content": [
    {
      "ReferenceID": "string",
      "FederationID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "Type": "openid_relying_party",
      "Version": 0,
      "Policy": "string",
      "Status": "active",
      "CreatedAt": "2024-07-29T15:51:28.071Z"
    }
  ],
  "totalPages": 0,
  "totalSize": 0,
  "pageable": {
    "number": 0,
    "sort": {
      "sorted": true,
      "orderBy": [
        {
          "property": "createdAt",
          "direction": "ASC",
          "ignoreCase": true,
          "ascending": true
        }
      ]
    },
    "size": 0,
    "offset": 0,
    "sorted": true,
    "unpaged": true
  },
  "numberOfElements": 0,
  "size": 0,
  "offset": 0,
  "empty": true,
  "pageNumber": 0
}

401

Unauthorized

Response Headers

• x-fapi-interaction-id

  string

403

Forbidden

Response Headers

• x-fapi-interaction-id

  string

404

Not found

Response Headers

• x-fapi-interaction-id

  string

application/json

Schema

Schema

errors string[]

Validation Error messages

Example (from schema)

{
  "errors": [
    "string"
  ]
}

500

Internal Server Error

Response Headers

• x-fapi-interaction-id

  string

502

Bad Gateway

Response Headers

• x-fapi-interaction-id

  string

504

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

Response Headers

• x-fapi-interaction-id

  string

Loading...