diff options
| author | Max Wittig <max.wittig95@gmail.com> | 2020-01-26 21:19:35 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-01-26 21:19:35 +0100 |
| commit | 7843ace913589cf629f448a2541f290a4c7214cd (patch) | |
| tree | b6b38c84f00be8ceb4ea83a0441af09710f1da32 | |
| parent | df485a92b713a0f2f983c72d9d41ea3a771abf88 (diff) | |
| parent | c9329bbf028c5e5ce175e99859c9e842ab8234bc (diff) | |
| download | gitlab-7843ace913589cf629f448a2541f290a4c7214cd.tar.gz | |
Merge pull request #1000 from matusf/update-auth-docs
Update auth docs
| -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 19fdea0..dc88684 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 85fc5e0..c9716c2 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. @@ -211,9 +209,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. |