Skip to content

Commit 8da142a

Browse files
committed
add comment for param api_key
1 parent dfcbcff commit 8da142a

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

cpapi/mgmt_api.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -151,14 +151,15 @@ def login(self, username=None, password=None, continue_last_session=False, domai
151151
"""
152152
performs a 'login' API call to the management server
153153
154-
:param username: Check Point admin name
155-
:param password: Check Point admin password
154+
:param username: Check Point admin name (Check Point credentials are [username & password] or api_key)
155+
:param password: Check Point admin password (Check Point credentials are [username & password] or api_key)
156156
:param continue_last_session: [optional] It is possible to continue the last Check Point session
157157
or to create a new one
158158
:param domain: [optional] The name, UID or IP-Address of the domain to login.
159159
:param read_only: [optional] Login with Read Only permissions. This parameter is not considered in case
160160
continue-last-session is true.
161161
:param payload: [optional] More settings for the login command
162+
:param api_key: Check Point api_key (Check Point credentials are [username & password] or api_key)
162163
:returns: APIResponse object
163164
:side-effects: updates the class's uid and server variables
164165
"""

0 commit comments

Comments
 (0)