jam.saml.types

types

Classes:

Name	Description
SAMLArtifactResolve	Parsed SAML ArtifactResolve.
SAMLArtifactResponse	Parsed SAML ArtifactResponse.
SAMLAssertion	Parsed SAML assertion data.
SAMLAttributeQuery	Parsed SAML AttributeQuery.
SAMLAuthnStatement	SAML authentication statement.
SAMLConditions	SAML assertion conditions (time constraints + audience).
SAMLLogoutRequest	Parsed SAML LogoutRequest.
SAMLLogoutResponse	Parsed SAML LogoutResponse.
SAMLManageNameIDRequest	Parsed SAML ManageNameIDRequest.
SAMLManageNameIDResponse	Parsed SAML ManageNameIDResponse.
SAMLMetadata	Parsed SAML metadata.
SAMLRequest	Parsed SAML AuthnRequest.
SAMLResponse	Parsed SAML protocol Response.
SAMLSubject	SAML assertion subject (NameID + confirmation).

SAMLArtifactResolve dataclass

SAMLArtifactResolve(
    id: str,
    issuer: str | None,
    issue_instant: datetime,
    artifact: str,
)

Parsed SAML ArtifactResolve.

SAMLArtifactResponse dataclass

SAMLArtifactResponse(
    id: str,
    issuer: str | None,
    issue_instant: datetime,
    status_code: str = "urn:oasis:names:tc:SAML:2.0:status:Success",
    in_response_to: str | None = None,
    original_message: str | None = None,
)

Parsed SAML ArtifactResponse.

SAMLAssertion dataclass

SAMLAssertion(
    id: str,
    issuer: str,
    issue_instant: datetime,
    subject: SAMLSubject | None = None,
    conditions: SAMLConditions | None = None,
    attributes: dict[str, Any] = dict(),
    authn_statement: SAMLAuthnStatement | None = None,
)

Parsed SAML assertion data.

SAMLAttributeQuery dataclass

SAMLAttributeQuery(
    id: str,
    issuer: str | None,
    issue_instant: datetime,
    subject: str,
    destination: str | None = None,
    attribute_names: list[str] | None = None,
)

Parsed SAML AttributeQuery.

SAMLAuthnStatement dataclass

SAMLAuthnStatement(
    authn_instant: datetime,
    session_index: str | None = None,
)

SAML authentication statement.

SAMLConditions dataclass

SAMLConditions(
    not_before: datetime | None = None,
    not_on_or_after: datetime | None = None,
    audience_restriction: list[str] = list(),
)

SAML assertion conditions (time constraints + audience).

SAMLLogoutRequest dataclass

SAMLLogoutRequest(
    id: str,
    issuer: str | None,
    issue_instant: datetime,
    name_id: str,
    session_index: str | None = None,
    destination: str | None = None,
)

Parsed SAML LogoutRequest.

SAMLLogoutResponse dataclass

SAMLLogoutResponse(
    id: str,
    issuer: str | None,
    issue_instant: datetime,
    status_code: str = "urn:oasis:names:tc:SAML:2.0:status:Success",
    destination: str | None = None,
    in_response_to: str | None = None,
)

Parsed SAML LogoutResponse.

SAMLManageNameIDRequest dataclass

SAMLManageNameIDRequest(
    id: str,
    issuer: str | None,
    issue_instant: datetime,
    name_id: str,
    new_id: str | None = None,
    destination: str | None = None,
)

Parsed SAML ManageNameIDRequest.

SAMLManageNameIDResponse dataclass

SAMLManageNameIDResponse(
    id: str,
    issuer: str | None,
    issue_instant: datetime,
    status_code: str = "urn:oasis:names:tc:SAML:2.0:status:Success",
    destination: str | None = None,
    in_response_to: str | None = None,
)

Parsed SAML ManageNameIDResponse.

SAMLMetadata dataclass

SAMLMetadata(
    entity_id: str,
    role: str,
    sso_url: str | None = None,
    acs_url: str | None = None,
    certificate: str | None = None,
    want_authn_requests_signed: bool = False,
    authn_requests_signed: bool = False,
)

Parsed SAML metadata.

SAMLRequest dataclass

SAMLRequest(
    id: str,
    issuer: str | None,
    issue_instant: datetime,
    destination: str | None = None,
    acs_url: str | None = None,
    binding: str | None = None,
)

Parsed SAML AuthnRequest.

SAMLResponse dataclass

SAMLResponse(
    id: str,
    issuer: str,
    issue_instant: datetime,
    status_code: str = "urn:oasis:names:tc:SAML:2.0:status:Success",
    destination: str | None = None,
    in_response_to: str | None = None,
    assertion: SAMLAssertion | None = None,
)

Parsed SAML protocol Response.

SAMLSubject dataclass

SAMLSubject(
    name_id: str,
    format: str = "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified",
    subject_confirmation_method: str = "urn:oasis:names:tc:SAML:2.0:cm:bearer",
    subject_confirmation_data: dict[str, Any] | None = None,
)

SAML assertion subject (NameID + confirmation).