openedx.core.djangoapps.api_admin.api.v1 package

openedx.core.djangoapps.api_admin.api.v1 package#

Submodules#

openedx.core.djangoapps.api_admin.api.v1.serializers module#

API v1 serializers.

class openedx.core.djangoapps.api_admin.api.v1.serializers.ApiAccessRequestSerializer(*args, **kwargs)#

Bases: ModelSerializer

ApiAccessRequest serializer.

class Meta#

Bases: object

fields = ('id', 'created', 'modified', 'user', 'status', 'website', 'reason', 'company_name', 'company_address', 'site', 'contacted')#
model#

alias of ApiAccessRequest

openedx.core.djangoapps.api_admin.api.v1.urls module#

URL definitions for api access request API v1.

openedx.core.djangoapps.api_admin.api.v1.views module#

API Views.

class openedx.core.djangoapps.api_admin.api.v1.views.ApiAccessRequestView(**kwargs)#

Bases: ListAPIView

Return API Access Requests in the form of a paginated list.

Raises:

  • NotFound – Raised if user with username provided in GET parameters does not exist.

  • PermissionDenied – Raised if username is provided in GET parameters but the requesting user does not have access rights to filter results.

Example

GET: /api-admin/api/v1/api_access_request/ {

“count”: 1, “num_pages”: 1, “current_page”: 1, “results”: [

{

“id”: 1, “created”: “2017-09-25T08:41:48.934364Z”, “modified”: “2017-09-25T08:42:04.185209Z”, “user”: 6, “status”: “denied”, “website”: “https://www.example.com/”, “reason”: “Example”, “company_name”: “Example Name”, “company_address”: “Silicon Valley”, “site”: 1, “contacted”: true

}

], “next”: null, “start”: 0, “previous”: null

}

authentication_classes = (<class 'edx_rest_framework_extensions.auth.jwt.authentication.JwtAuthentication'>, <class 'openedx.core.lib.api.authentication.BearerAuthentication'>, <class 'rest_framework.authentication.SessionAuthentication'>)#
filter_backends = (<class 'openedx.core.djangoapps.api_admin.api.filters.IsOwnerOrStaffFilterBackend'>, <class 'django_filters.rest_framework.backends.DjangoFilterBackend'>)#
filterset_fields = ('user__username', 'status', 'company_name', 'site__domain', 'contacted')#
permission_classes = (<class 'rest_framework.permissions.IsAuthenticated'>,)#
serializer_class#

alias of ApiAccessRequestSerializer

Module contents#