Skip to main content

A partial implementation of the SCIM 2.0 provider specification for use with Django.

Project description

tests coverage Documentation Status

This is a provider-side implementation of the SCIM 2.0 [1] specification for use in Django.

Note that currently the only supported database is Postgres.

Installation

Install with pip:

$ pip install django-scim2

Then add the django_scim app to INSTALLED_APPS in your Django’s settings:

INSTALLED_APPS = (
    ...
    'django_scim',
)

Add the appropriate middleware to authorize or deny the SCIM calls:

MIDDLEWARE_CLASSES = (
    ...
    'django_scim.middleware.SCIMAuthCheckMiddleware',
    ...
)

Make sure to place this middleware after authentication middleware as this middleware simply checks request.user.is_anonymous() to determine if the SCIM request should be allowed or denied.

Add the necessary url patterns to your root urls.py file. Please note that the namespace is mandatory and must be named scim:

# Django 1.11
urlpatterns = [
    ...
    url(r'^scim/v2/', include('django_scim.urls', namespace='scim')),
]

# Django 2+
urlpatterns = [
    ...
    path('scim/v2/', include('django_scim.urls')),
]

Finally, add settings appropriate for you app to your settings.py file:

SCIM_SERVICE_PROVIDER = {
    'NETLOC': 'localhost',
    'AUTHENTICATION_SCHEMES': [
        {
            'type': 'oauth2',
            'name': 'OAuth 2',
            'description': 'Oauth 2 implemented with bearer token',
        },
    ],
}

Other SCIM settings can be provided but those listed above are required.

PyPI

https://pypi.python.org/pypi/django-scim2

Source

https://github.com/15five/django-scim2

Documentation

https://django-scim2.readthedocs.io/

Tests

https://github.com/15five/django-scim2/actions

Coverage

https://codecov.io/gh/15five/django-scim2/

License

This library is released under the terms of the MIT license. Full details in LICENSE.txt file.

Extensibility

This library was forked and developed to be highly extensible. A number of adapters can be defined to control what different endpoints do to your resources. Please see the documentation for more details.

PLEASE NOTE: This app does not implement authorization and authentication. Such tasks are left for other apps such as Django OAuth Toolkit to implement.

Credits

This project was forked from https://bitbucket.org/atlassian/django_scim

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-scim2-0.16.3.tar.gz (26.6 kB view details)

Uploaded Source

Built Distribution

django_scim2-0.16.3-py3-none-any.whl (31.0 kB view details)

Uploaded Python 3

File details

Details for the file django-scim2-0.16.3.tar.gz.

File metadata

  • Download URL: django-scim2-0.16.3.tar.gz
  • Upload date:
  • Size: 26.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.5 CPython/3.8.1 Darwin/19.6.0

File hashes

Hashes for django-scim2-0.16.3.tar.gz
Algorithm Hash digest
SHA256 23a8cac572df1f2b6d426fdee2be9f41843b098b2aa7b955c406ba9ad740a84d
MD5 fc84c3e0dfc3796076012be207f00b38
BLAKE2b-256 08f33377045b8448ab374e794b3a13b3aa037b885609bee40bc1b0d559d35400

See more details on using hashes here.

Provenance

File details

Details for the file django_scim2-0.16.3-py3-none-any.whl.

File metadata

  • Download URL: django_scim2-0.16.3-py3-none-any.whl
  • Upload date:
  • Size: 31.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.5 CPython/3.8.1 Darwin/19.6.0

File hashes

Hashes for django_scim2-0.16.3-py3-none-any.whl
Algorithm Hash digest
SHA256 6be682ee980ee24e0ced13bcc48ba8cde73dbf11694b2b3974d5ce9b6f154ea9
MD5 5d9c32489a4f41545e74c0c002155aa6
BLAKE2b-256 064fe99fca872baf42d34a9da3e539695fdd47de1883ab43374bd160a9ebe37d

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page