Module esaml

SAML for Erlang.

Behaviours: application, supervisor.

Description

SAML for Erlang

Data Types

assertion()

assertion() = #esaml_assertion{version = esaml:version(), issue_instant = esaml:datetime(), recipient = string(), issuer = string(), subject = esaml:subject(), conditions = esaml:conditions(), attributes = proplists:proplist()}

authnreq()

authnreq() = #esaml_authnreq{version = esaml:version(), issue_instant = esaml:datetime(), destination = string(), issuer = string(), consumer_location = string()}

condition()

condition() = {not_before, esaml:datetime()} | {not_on_or_after, esaml:datetime()} | {audience, string()}

conditions()

conditions() = [condition()]

contact()

contact() = #esaml_contact{name = string(), email = string()}

datetime()

datetime() = string() | binary()

idp_metadata()

idp_metadata() = #esaml_idp_metadata{org = esaml:org(), tech = esaml:contact(), signed_requests = boolean(), certificate = binary() | undefined, entity_id = string(), login_location = string(), logout_location = string() | undefined, name_format = esaml:name_format()}

localized_string()

localized_string() = string() | [{Locale::atom(), LocalizedString::string()}]

logout_reason()

logout_reason() = user | admin

logoutreq()

logoutreq() = #esaml_logoutreq{version = esaml:version(), issue_instant = esaml:datetime(), destination = string(), issuer = string(), name = string(), reason = esaml:logout_reason()}

logoutresp()

logoutresp() = #esaml_logoutresp{version = esaml:version(), issue_instant = esaml:datetime(), destination = string(), issuer = string(), status = esaml:status_code()}

name_format()

name_format() = email | x509 | windows | krb | persistent | transient | unknown

org()

org() = #esaml_org{name = esaml:localized_string(), displayname = esaml:localized_string(), url = esaml:localized_string()}

response()

response() = #esaml_response{version = esaml:version(), issue_instant = esaml:datetime(), destination = string(), issuer = string(), status = esaml:status_code(), assertion = esaml:assertion()}

saml_record()

saml_record() = org() | contact() | sp_metadata() | idp_metadata() | authnreq() | subject() | assertion() | logoutreq() | logoutresp() | response()

sp()

sp() = #esaml_sp{org = esaml:org(), tech = esaml:contact(), key = #'RSAPrivateKey'{} | undefined, certificate = binary() | undefined, cert_chain = [binary()], sp_sign_requests = boolean(), idp_signs_assertions = boolean(), idp_signs_envelopes = boolean(), idp_signs_logout_requests = boolean(), sp_sign_metadata = boolean(), trusted_fingerprints = [string() | binary()], metadata_uri = string(), consume_uri = string(), logout_uri = string() | undefined}

sp_metadata()

sp_metadata() = #esaml_sp_metadata{org = esaml:org(), tech = esaml:contact(), signed_requests = boolean(), signed_assertions = boolean(), certificate = binary() | undefined, cert_chain = [binary()], entity_id = string(), consumer_location = string(), logout_location = string() | undefined}

status_code()

status_code() = success | request_error | response_error | bad_version | authn_failed | bad_attr | denied | bad_binding | unknown

subject()

subject() = #esaml_subject{name = string(), confirmation_method = atom(), notonorafter = esaml:datetime()}

version()

version() = string()

Function Index

config/1Retrieve a config record.
config/2Retrieve a config record with default.

Function Details

config/1

config(Name::atom()) -> term() | undefined

Retrieve a config record

config/2

config(Name::atom(), Default::term()) -> term()

Retrieve a config record with default


Generated by EDoc, Apr 11 2015, 09:38:34.