pysaml2 icon indicating copy to clipboard operation
pysaml2 copied to clipboard

`contact_person` documentation is incorrect.

Open dino8890 opened this issue 6 months ago • 2 comments

The example shown is incorrect as it contains invalid configuration keys for every attribute other than company. The problem is that when using the example configuration, metadata won't be generated properly.

Here's an example of correct configuration:

'contact_person': [
    {
        'given_name': 'Fox',
        'sur_name': 'Mulder',
        
        'company': 'The X-Files',
        'email_address': ['[email protected]'],
        'telephone_number': ['+1 234 567 89'],

        # accepted values: technical, support, administrative, billing and other
        'contact_type': 'technical',
    },
]

I'll send a PR with the corrected example withing a day or two, and I will expand upon the current description.

dino8890 avatar May 14 '25 19:05 dino8890

Ah, good catch!

In the example configs in SATOSA, the keys are spelled correctly: saml2_frontend.yaml.example, saml2_backend.yaml.example - but thanks for catching this in the documentation for pysaml2.

I submitted a PR just now! It's the #989.

dino8890 avatar May 15 '25 08:05 dino8890

Thank you!

c00kiemon5ter avatar Oct 05 '25 19:10 c00kiemon5ter