5.7.223. Bugzilla::Extension::SAML2Auth::IDP¶
5.7.223.1. Description¶
Bugzilla::Extension::SAML2Auth::IDP - A module for encapsulating IDP metadata.
5.7.223.2. Fields¶
- id
The index for this IDP in the database.
- name
The name of this IDP.
- cacert
The full path to the CA certificate file used to authenticate certificates from this IDP.
- icon
The FontAwesome icon used in the Login Menu for this IDP.
- url
The metadata URL for this IDP.
- metadata
A stored copy of this IDPs metadata.
- expires
The date this IDPs stored metadata expires.
- isactive
Is this IDP allowed to be used?
- userregexp
A perl regular expression for email addresses to allow or deny for this IDP.
- groups
A collection of groups who are NOT permitted to use this IDP.
- saml_extern_id_attr
The attribute in the SAML response that conatins the unique external ID.
- ldap_extern_id_attr
The attribute in LDAP that conatins the unique external ID.
- ldap_mail_attrs
A comma separated list of LDAP attributes to use for mail address, in descending order of preference.
- group_skip_attr
An attribute in the SAML response that allows bypassing the group restriction.
- ldap_mail_attrs
The value in the SAML attribute that allows bypassing the group restriction.
5.7.223.3. Accessors¶
These methods allow you to get the specified field from the IPD.
- id
- name
- cacert
- icon
- url
- metadata
- expires
- isactive
- userregexp
- groups
- saml_extern_id_attr
- ldap_extern_id_attr
- ldap_mail_attrs
- expired
A function that checks to see if the expires date has passed.
5.7.223.4. Methods¶
These methods allow you to set the spcified field from the IPD.
- set_name
- set_cacert
- set_icon
- set_url
- set_metadata
- set_expires
- set_isactive
- set_userregexp
- set_groups
- set_saml_extern_id_attr
- set_ldap_extern_id_attr
- set_ldap_mail_attrs
- set_group_skip_attr
- set_group_skip_value
This documentation undoubtedly has bugs; if you find some, please file them here.
