Static Token Auth Example

[BrokenStandards]

Documentation is missing an example for Static Token based authentication, which does not use a username or password. The only thing different from the username/password based auth is you replace the username/password with the token and set encryption to true.

def test_static_token_auth_success():
    """Test static token authentication.
    
    Test whether a connection to API can be established using
    a static token (ssl_code security mode).
    """
    connection_kwargs = {
        'url': server['url'],
        'app_id': 'static_app',
        'token': server['static_token'],
        'ssl_verify': server['ssl_verify'],
        'encryption': True
    }
    
    pi = phpypam.api(**connection_kwargs)
    
    # Token should be set directly from static token
    assert isinstance(pi, phpypam.api)
    assert pi.get_token() == server['static_token']
    
    # Test that we can actually use the API
    controllers = pi.controllers()
    assert isinstance(controllers, set)
    assert len(controllers) > 0

Setting encryption to true bypasses the http auth the code would otherwise try to do which would cause authentication to fail.

[cmeissner]

Hi @BrokenStandards, thank you for bringing this to our attention. I have to confess that we never used that feature, but you are right. If it works, this part should be part of the docs. Would you mind opening a PR for that documentation change? Your code from above could also be part of the test suite, but I think this will need to create a token first?

[BrokenStandards]

I will gladly update the docs. I actually already wrote an authentication test as well. I got the token setup working and whatnot. It's similar to the existing ansible token, except using ssl_code instead of ssl_token iirc. It might be a few days before I get back to it, but should be relatively soon