diff options
| author | Matus Ferech <matus.ferech@telekom.com> | 2020-01-26 20:37:08 +0100 |
|---|---|---|
| committer | Matus Ferech <matus.ferech@telekom.com> | 2020-01-26 20:37:08 +0100 |
| commit | c9329bbf028c5e5ce175e99859c9e842ab8234bc (patch) | |
| tree | ef350908b1da4c87a2df337fe8e4c45f0753fada | |
| parent | 7fd3226fc6b629d503bc1b0a657bc21f69bc4696 (diff) | |
| download | gitlab-c9329bbf028c5e5ce175e99859c9e842ab8234bc.tar.gz | |
docs(auth): remove email/password auth
| -rw-r--r-- | docs/api-usage.rst | 3 | ||||
| -rw-r--r-- | gitlab/__init__.py | 6 |
2 files changed, 1 insertions, 8 deletions
diff --git a/docs/api-usage.rst b/docs/api-usage.rst index d211e25..12c3dc7 100644 --- a/docs/api-usage.rst +++ b/docs/api-usage.rst @@ -23,9 +23,6 @@ To connect to a GitLab server, create a ``gitlab.Gitlab`` object: import os gl = gitlab.Gitlab('http://10.0.0.1', job_token=os.environ['CI_JOB_TOKEN']) - # username/password authentication (for GitLab << 10.2) - gl = gitlab.Gitlab('http://10.0.0.1', email='jdoe', password='s3cr3t') - # anonymous gitlab instance, read-only for public resources gl = gitlab.Gitlab('http://10.0.0.1') diff --git a/gitlab/__init__.py b/gitlab/__init__.py index 9cb027b..e7d1df6 100644 --- a/gitlab/__init__.py +++ b/gitlab/__init__.py @@ -60,8 +60,6 @@ class Gitlab(object): private_token (str): The user private token oauth_token (str): An oauth token job_token (str): A CI job token - email (str): The user email or login. - password (str): The user password (associated with email). ssl_verify (bool|str): Whether SSL certificates should be validated. If the value is a string, it is the path to a CA file used for certificate validation. @@ -203,9 +201,7 @@ class Gitlab(object): ) def auth(self): - """Performs an authentication. - - Uses either the private token, or the email/password pair. + """Performs an authentication using private token. The `user` attribute will hold a `gitlab.objects.CurrentUser` object on success. |