Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update_integration() function parameter clarification. Closes #280 #281

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions duo_client/admin.py
Original file line number Diff line number Diff line change
Expand Up @@ -2792,15 +2792,15 @@ def update_integration(self,
trusted_device_days=None,
ip_whitelist=None,
ip_whitelist_enroll_policy=None,
groups_allowed=None,
groups_allowed=None, policy_key=None,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we split this into two lines, to be consistent with the surroundings?

self_service_allowed=None,
sso=None):
"""Updates an integration.

integration_key - The key of the integration to update. (required)
name - The name of the integration (optional)
visual_style - (optional, default 'default')
See adminapi docs for possible values.
Deprecated. May be removed in a future release.
greeting - Voice greeting (optional, default '')
notes - internal use (optional, uses default setting)
enroll_policy - <'enroll'|'allow'|'deny'> (optional, default 'enroll')
Expand All @@ -2818,6 +2818,8 @@ def update_integration(self,
adminapi_write_resource - True|False|None
reset_secret_key - <any value>|None
groups_allowed - <str: CSV list of gkeys of groups allowed to auth>
policy_key - <str: policy key of custom application policy>|None
An empty string results in removal of any existing policy key setting.
self_service_allowed - True|False|None
sso - <dict: parameters for generic single sign-on> (optional)
New argument for unreleased feature. Will return an error if used.
Expand All @@ -2838,6 +2840,8 @@ def update_integration(self,
if name is not None:
params['name'] = name
if visual_style is not None:
warnings.warn("The 'visual_style' argument is deprecated. May be removed in a future release.",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we do this other places, for deprecated parameters?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. In get_authentication_log() and get_group()

DeprecationWarning, stacklevel=2)
params['visual_style'] = visual_style
if greeting is not None:
params['greeting'] = greeting
Expand Down Expand Up @@ -2873,6 +2877,8 @@ def update_integration(self,
params['reset_secret_key'] = '1'
if groups_allowed is not None:
params['groups_allowed'] = groups_allowed
if policy_key is not None:
params['policy_key'] = policy_key
if self_service_allowed is not None:
params['self_service_allowed'] = '1' if self_service_allowed else '0'
if sso is not None:
Expand Down
Loading