List aggregate metadata preview entities.

GET

/api/admin/saml-metadata/previews/{previewId}/entities

Code sample: Shell / cURL

curl --request GET \
  --url 'https://auth.example.com/api/admin/saml-metadata/previews/example/entities?offset=0&limit=50' \
  --header 'Authorization: Bearer <token>'

Lists EntityDescriptor summaries discovered in an aggregate metadata preview, with optional text and keyword filtering.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

previewId

required

string

Aggregate metadata preview id.

Query Parameters

query

string

Free-text search over entity identifiers and display names.

keyword

string

Keyword facet filter. Repeat the parameter to apply multiple keywords.

offset

integer

0

Pagination offset.

limit

integer

default: 50 >= 1 <= 200

Maximum number of entities to return.

Responses

200

Aggregate metadata entities for a preview.

Media type application/json

object

previewId

required

string

total

required

integer

offset

required

integer

limit

required

integer

entities

required

Array<object>

object

entityId

required

string

role

required

string

Allowed values: saml_idp saml_sp ambiguous unknown

displayName

string

acsUrl

string format: uri

ssoUrl

string format: uri

sloUrl

string format: uri

certificateCount

required

integer

validUntil

string

keywords

Array<string>

logoUrl

string format: uri

keywordFacets

Array<object>

object

category

required

string

label

required

string

values

required

Array<object>

object

keyword

required

string

label

required

string

count

required

integer

Example

{
  "previewId": "preview_123",
  "total": 1,
  "offset": 0,
  "limit": 50,
  "entities": [
    {
      "entityId": "https://sp.example.com/metadata",
      "role": "saml_sp",
      "displayName": "Example SP",
      "acsUrl": "https://sp.example.com/saml/acs",
      "certificateCount": 1,
      "keywords": [
        "education"
      ]
    }
  ]
}