Specs

cache(idp :: Shin.IdP.t(), entity_ids :: binary() | list()) :: list()

Similar to query3 but no metadata is returned - its purpose is to prime the IdP's cached metadata.

The IDs of entities that were actually found and cached will be returned as a list.

Examples

  ["https://test.ukfederation.org.uk/entity"] = Shin.Metadata.cache(idp, "https://test.ukfederation.org.uk/entity")
  ["https://test.ukfederation.org.uk/entity"] = Shin.Metadata.cache(idp, ["https://test.ukfederation.org.uk/entity", "http://example.com/fake"])

Specs

providers(idp :: Shin.IdP.t()) :: list()

Lists active/known metadata providers at the IdP.

Each metadata provider is a source of entity metadata. Shin makes a metrics API query to find them.

Examples

  providers = Shin.Metadata.providers(idp)

Specs

query(idp :: Shin.IdP.t(), entity_id :: binary(), options :: keyword()) ::
  {:ok, binary()} | {:error, binary()}

Query the IdP for metadata, returning the XML metadata for the specified entity ID if it can be found by the IdP.

Metadata is looked up using the IdP's metadata providers, using each one in turn until metadata is found.

The metadata XML is not parsed or validated in any way. If you need that sort of thing please take a look at the Smee library.

Pass the IdP and the entity ID of the SP.

Examples

  {:ok, metadata_xml} = Shin.Metadata.query(idp, "https://test.ukfederation.org.uk/entity")

Specs

query!(idp :: Shin.IdP.t(), entity_id :: binary(), options :: keyword()) ::
  binary()

Query the IdP for metadata, returning the XML metadata for the specified entity ID if it can be found by the IdP.

Metadata is looked up using the IdP's metadata providers, using each one in turn until metadata is found.

The metadata XML is not parsed or validated in any way. If you need that sort of thing please take a look at the Smee library.

Pass the IdP and the entity ID of the SP.

Examples

  metadata_xml = Shin.Metadata.query!(idp, "https://test.ukfederation.org.uk/entity")

Specs

reload(idp :: Shin.IdP.t(), mdp_id :: binary(), options :: keyword()) ::
  {:ok, binary()} | {:error, binary()}

Sends a reload request for the specified metadata provider to the IdP. This should cause the IdP to reset and reload the metadata associated with that provider.

Pass an IdP as the first parameter. The second parameter must be the provider name. You can list active providers with Metadata.providers/1

Examples

  {:ok, _} = Shin.Metadata.reload(idp, "ukFederationMDQ")