django-okta-authentication


Namedjango-okta-authentication JSON
Version 1.2.1 PyPI version JSON
download
home_pagehttps://github.com/jasonchrista/django-okta-auth
SummaryAuthenticated users using Okta
upload_time2023-11-13 19:31:09
maintainer
docs_urlNone
authorJason Christa
requires_python
license
keywords
VCS
bugtrack_url
requirements PyJWT cryptography
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Django Okta Auth
=================

*Django Okta Auth* allows you to authenticate through Okta.

Installation
------------

Run ``pip install django-okta-authentication``

Add the ``OktaBackend`` to your ``AUTHENTICATION_BACKENDS`` setting:

.. code:: python

   AUTHENTICATION_BACKENDS = (
       ...
       'okta_auth.backends.OktaBackend',
   )

Edit your ``urls.py`` to include:

.. code:: python

   urlpatterns = [
       url(r'^okta/', include('okta_auth.urls')),
       ...
   ]

Settings
--------

OKTA_DOMAIN
~~~~~~~~~~~

Okta domain.

OKTA_CLIENT_ID
~~~~~~~~~~~~~~

Okta client id.

OKTA_CLIENT_SECRET
~~~~~~~~~~~~~~~~~~

Okta client secret.

OKTA_SCOPE
~~~~~~~~~~

**default:** ``'openid email'`` OAuth scope parameter.

OKTA_RESPONSE_TYPE
~~~~~~~~~~~~~~~~~~~

**default:** ``'id_token'`` OAuth response type parameter.

OKTA_USER_CREATION
~~~~~~~~~~~~~~~~~~

**default:** ``True`` Allow creation of new users after successful
authentication.

Logging
-------

To enable logging add ``okta_auth`` to ``LOGGING['loggers']`` options.

.. code:: python

   LOGGING = {
       ...,
       'loggers': {
           ...,
           'okta_auth': {
               'handlers': ['console'],
               'level': 'DEBUG',
           }
       }
   }

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/jasonchrista/django-okta-auth",
    "name": "django-okta-authentication",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Jason Christa",
    "author_email": "jason@zeitcode.com",
    "download_url": "https://files.pythonhosted.org/packages/ef/b8/ca286b12d88afa627970f2e08cb86be16427b5adc165723323b79ed65170/django-okta-authentication-1.2.1.tar.gz",
    "platform": null,
    "description": "Django Okta Auth\n=================\n\n*Django Okta Auth* allows you to authenticate through Okta.\n\nInstallation\n------------\n\nRun ``pip install django-okta-authentication``\n\nAdd the ``OktaBackend`` to your ``AUTHENTICATION_BACKENDS`` setting:\n\n.. code:: python\n\n   AUTHENTICATION_BACKENDS = (\n       ...\n       'okta_auth.backends.OktaBackend',\n   )\n\nEdit your ``urls.py`` to include:\n\n.. code:: python\n\n   urlpatterns = [\n       url(r'^okta/', include('okta_auth.urls')),\n       ...\n   ]\n\nSettings\n--------\n\nOKTA_DOMAIN\n~~~~~~~~~~~\n\nOkta domain.\n\nOKTA_CLIENT_ID\n~~~~~~~~~~~~~~\n\nOkta client id.\n\nOKTA_CLIENT_SECRET\n~~~~~~~~~~~~~~~~~~\n\nOkta client secret.\n\nOKTA_SCOPE\n~~~~~~~~~~\n\n**default:** ``'openid email'`` OAuth scope parameter.\n\nOKTA_RESPONSE_TYPE\n~~~~~~~~~~~~~~~~~~~\n\n**default:** ``'id_token'`` OAuth response type parameter.\n\nOKTA_USER_CREATION\n~~~~~~~~~~~~~~~~~~\n\n**default:** ``True`` Allow creation of new users after successful\nauthentication.\n\nLogging\n-------\n\nTo enable logging add ``okta_auth`` to ``LOGGING['loggers']`` options.\n\n.. code:: python\n\n   LOGGING = {\n       ...,\n       'loggers': {\n           ...,\n           'okta_auth': {\n               'handlers': ['console'],\n               'level': 'DEBUG',\n           }\n       }\n   }\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Authenticated users using Okta",
    "version": "1.2.1",
    "project_urls": {
        "Homepage": "https://github.com/jasonchrista/django-okta-auth"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "efb8ca286b12d88afa627970f2e08cb86be16427b5adc165723323b79ed65170",
                "md5": "a4a12d75fb39548ee2a3f8ae4dbc95b2",
                "sha256": "c7e6afbcad5f56f6059e37e422adb50f1ea232a73d0d0a99898769ec8321bab1"
            },
            "downloads": -1,
            "filename": "django-okta-authentication-1.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "a4a12d75fb39548ee2a3f8ae4dbc95b2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 6798,
            "upload_time": "2023-11-13T19:31:09",
            "upload_time_iso_8601": "2023-11-13T19:31:09.290312Z",
            "url": "https://files.pythonhosted.org/packages/ef/b8/ca286b12d88afa627970f2e08cb86be16427b5adc165723323b79ed65170/django-okta-authentication-1.2.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-13 19:31:09",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "jasonchrista",
    "github_project": "django-okta-auth",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "PyJWT",
            "specs": [
                [
                    ">=",
                    "1.1.0"
                ]
            ]
        },
        {
            "name": "cryptography",
            "specs": [
                [
                    ">=",
                    "3.0.0"
                ]
            ]
        }
    ],
    "tox": true,
    "lcname": "django-okta-authentication"
}
        
Elapsed time: 0.18403s