Claims verifiers

federatedidentity.verifiers

Utility functions for constructing claims verifiers suitable for passing to verify_id_token.

all_claims_present(
    claim_names: Iterable[str],
) -> ClaimVerifier

Verifies that all claims in required_claims are present.

Parameters:

Name	Type	Description	Default
`claim_names`	`Iterable[str]`	Iterable of claim names.	required

Returns:

Type	Description
`ClaimVerifier`	A claims verifier.

only_for_issuers(
    issuers: Container[str],
    required_claims: Iterable[ClaimVerifier],
) -> ClaimVerifier

Apply claim verifiers only for a particular set of issuers.

Parameters:

Name	Type	Description	Default
`issuers`	`Container[str]`	Issuer names which should have the claims verifiers in `required_claims` applied.	required
`required_claims`	`Iterable[ClaimVerifier]`	Iterable of claim verifiers to run if the token matches one of the issuers in `issuers`.	required

Returns:

Type	Description
`ClaimVerifier`	A claims verifier.