API docs by Redocly

OpenBook REST API (0.0.1-pre1)

Download OpenAPI specification:

License: GNU Affero General Public License, Version 3 (or later)

Interactive Online Textbooks

Course Material Page Ranges

List

Course Material Page Ranges

Authorizations:
SessionAuthentication
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

_page
integer

A page number within the paginated result set.

_page_size
integer

Number of results to return per page.

_search
string

A search term.

_sort
string

Which field to use when ordering the results.

created_at
string <date-time>
created_at__gte
string <date-time>
created_at__lte
string <date-time>
created_by
string
end_page
string <uuid>
material
string <uuid>
modified_at
string <date-time>
modified_at__gte
string <date-time>
modified_at__lte
string <date-time>
modified_by
string
position
integer
position__gte
integer
position__lte
integer
start_page
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?_page=4",
  • "previous": "http://api.example.org/accounts/?_page=2",
  • "results": [
    ]
}

Create

Course Material Page Ranges

Authorizations:
SessionAuthentication
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
required
material
required
string <uuid> (Course Material)
start_page
required
string <uuid>
end_page
required
string <uuid>
position
integer <int64> [ 0 .. 9223372036854776000 ]
Default: 0

Order of the selected ranges within one syllabus item.

Responses

Request samples

Content type
{
  • "material": "be3e45d3-48cf-433e-8e12-9a985585421b",
  • "start_page": "692bebe2-c658-45e7-823a-c3394d47f2a7",
  • "end_page": "62537bae-31e0-452e-85c5-c52a5df23220",
  • "position": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "material": "be3e45d3-48cf-433e-8e12-9a985585421b",
  • "start_page": "692bebe2-c658-45e7-823a-c3394d47f2a7",
  • "end_page": "62537bae-31e0-452e-85c5-c52a5df23220",
  • "position": 0,
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Retrieve

Course Material Page Ranges

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Course Material Page Range.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "material": "be3e45d3-48cf-433e-8e12-9a985585421b",
  • "start_page": "692bebe2-c658-45e7-823a-c3394d47f2a7",
  • "end_page": "62537bae-31e0-452e-85c5-c52a5df23220",
  • "position": 0,
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Update

Course Material Page Ranges

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Course Material Page Range.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
required
material
required
string <uuid> (Course Material)
start_page
required
string <uuid>
end_page
required
string <uuid>
position
integer <int64> [ 0 .. 9223372036854776000 ]
Default: 0

Order of the selected ranges within one syllabus item.

Responses

Request samples

Content type
{
  • "material": "be3e45d3-48cf-433e-8e12-9a985585421b",
  • "start_page": "692bebe2-c658-45e7-823a-c3394d47f2a7",
  • "end_page": "62537bae-31e0-452e-85c5-c52a5df23220",
  • "position": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "material": "be3e45d3-48cf-433e-8e12-9a985585421b",
  • "start_page": "692bebe2-c658-45e7-823a-c3394d47f2a7",
  • "end_page": "62537bae-31e0-452e-85c5-c52a5df23220",
  • "position": 0,
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Partial Update

Course Material Page Ranges

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Course Material Page Range.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
material
string <uuid> (Course Material)
start_page
string <uuid>
end_page
string <uuid>
position
integer <int64> [ 0 .. 9223372036854776000 ]
Default: 0

Order of the selected ranges within one syllabus item.

Responses

Request samples

Content type
{
  • "material": "be3e45d3-48cf-433e-8e12-9a985585421b",
  • "start_page": "692bebe2-c658-45e7-823a-c3394d47f2a7",
  • "end_page": "62537bae-31e0-452e-85c5-c52a5df23220",
  • "position": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "material": "be3e45d3-48cf-433e-8e12-9a985585421b",
  • "start_page": "692bebe2-c658-45e7-823a-c3394d47f2a7",
  • "end_page": "62537bae-31e0-452e-85c5-c52a5df23220",
  • "position": 0,
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Delete

Course Material Page Ranges

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Course Material Page Range.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Course Materials

List

Course Materials

Authorizations:
SessionAuthentication
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

_page
integer

A page number within the paginated result set.

_page_size
integer

Number of results to return per page.

_search
string

A search term.

_sort
string

Which field to use when ordering the results.

course
string <uuid>
created_at
string <date-time>
created_at__gte
string <date-time>
created_at__lte
string <date-time>
created_by
string
modified_at
string <date-time>
modified_at__gte
string <date-time>
modified_at__lte
string <date-time>
modified_by
string
position
integer
position__gte
integer
position__lte
integer
textbook
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?_page=4",
  • "previous": "http://api.example.org/accounts/?_page=2",
  • "results": [
    ]
}

Create

Course Materials

Authorizations:
SessionAuthentication
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
required
course
required
string <uuid>
textbook
string or null <uuid>
position
integer <int64> [ 0 .. 9223372036854776000 ]
Default: 0

Reading order index inside the course syllabus.

Responses

Request samples

Content type
{
  • "course": "4c88e8b1-8fa9-4021-9bad-b22efe4d02eb",
  • "textbook": "9ec8aad7-8b6d-44a2-8a0f-6a86ccf0f1fb",
  • "position": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "course": "4c88e8b1-8fa9-4021-9bad-b22efe4d02eb",
  • "textbook": "9ec8aad7-8b6d-44a2-8a0f-6a86ccf0f1fb",
  • "position": 0,
  • "page_ranges": [
    ],
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Retrieve

Course Materials

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Course Material.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "course": "4c88e8b1-8fa9-4021-9bad-b22efe4d02eb",
  • "textbook": "9ec8aad7-8b6d-44a2-8a0f-6a86ccf0f1fb",
  • "position": 0,
  • "page_ranges": [
    ],
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Update

Course Materials

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Course Material.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
required
course
required
string <uuid>
textbook
string or null <uuid>
position
integer <int64> [ 0 .. 9223372036854776000 ]
Default: 0

Reading order index inside the course syllabus.

Responses

Request samples

Content type
{
  • "course": "4c88e8b1-8fa9-4021-9bad-b22efe4d02eb",
  • "textbook": "9ec8aad7-8b6d-44a2-8a0f-6a86ccf0f1fb",
  • "position": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "course": "4c88e8b1-8fa9-4021-9bad-b22efe4d02eb",
  • "textbook": "9ec8aad7-8b6d-44a2-8a0f-6a86ccf0f1fb",
  • "position": 0,
  • "page_ranges": [
    ],
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Partial Update

Course Materials

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Course Material.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
course
string <uuid>
textbook
string or null <uuid>
position
integer <int64> [ 0 .. 9223372036854776000 ]
Default: 0

Reading order index inside the course syllabus.

Responses

Request samples

Content type
{
  • "course": "4c88e8b1-8fa9-4021-9bad-b22efe4d02eb",
  • "textbook": "9ec8aad7-8b6d-44a2-8a0f-6a86ccf0f1fb",
  • "position": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "course": "4c88e8b1-8fa9-4021-9bad-b22efe4d02eb",
  • "textbook": "9ec8aad7-8b6d-44a2-8a0f-6a86ccf0f1fb",
  • "position": 0,
  • "page_ranges": [
    ],
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Delete

Course Materials

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Course Material.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Library Groups

List

Library Groups

Authorizations:
SessionAuthentication
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

_page
integer

A page number within the paginated result set.

_page_size
integer

Number of results to return per page.

_search
string

A search term.

_sort
string

Which field to use when ordering the results.

created_at
string <date-time>
created_at__gte
string <date-time>
created_at__lte
string <date-time>
created_by
string
modified_at
string <date-time>
modified_at__gte
string <date-time>
modified_at__lte
string <date-time>
modified_by
string
name
string
owner
integer
parent
string <uuid>
slug
string

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?_page=4",
  • "previous": "http://api.example.org/accounts/?_page=2",
  • "results": [
    ]
}

Create

Library Groups

Authorizations:
SessionAuthentication
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
required
slug
required
string <= 50 characters ^[-a-zA-Z0-9_]+$
name
required
string <= 255 characters
description
string
text_format
string (TextFormatEnum)
Enum: "TEXT" "HTML" "MD"
  • TEXT - Plain Text
  • HTML - HTML
  • MD - Markdown
parent
string or null <uuid> (Parent Group)
public_permissions
required
Array of strings

Responses

Request samples

Content type
{
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
  • "public_permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
  • "children": [
    ],
  • "textbooks": [
    ],
  • "courses": [
    ],
  • "links": [
    ],
  • "owner": "string",
  • "public_permissions": [
    ],
  • "role_assignments": [
    ],
  • "enrollment_methods": [
    ],
  • "access_requests": [
    ],
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Retrieve

Library Groups

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Library Group.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
  • "children": [
    ],
  • "textbooks": [
    ],
  • "courses": [
    ],
  • "links": [
    ],
  • "owner": "string",
  • "public_permissions": [
    ],
  • "role_assignments": [
    ],
  • "enrollment_methods": [
    ],
  • "access_requests": [
    ],
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Update

Library Groups

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Library Group.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
required
slug
required
string <= 50 characters ^[-a-zA-Z0-9_]+$
name
required
string <= 255 characters
description
string
text_format
string (TextFormatEnum)
Enum: "TEXT" "HTML" "MD"
  • TEXT - Plain Text
  • HTML - HTML
  • MD - Markdown
parent
string or null <uuid> (Parent Group)
public_permissions
required
Array of strings

Responses

Request samples

Content type
{
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
  • "public_permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
  • "children": [
    ],
  • "textbooks": [
    ],
  • "courses": [
    ],
  • "links": [
    ],
  • "owner": "string",
  • "public_permissions": [
    ],
  • "role_assignments": [
    ],
  • "enrollment_methods": [
    ],
  • "access_requests": [
    ],
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Partial Update

Library Groups

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Library Group.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
slug
string <= 50 characters ^[-a-zA-Z0-9_]+$
name
string <= 255 characters
description
string
text_format
string (TextFormatEnum)
Enum: "TEXT" "HTML" "MD"
  • TEXT - Plain Text
  • HTML - HTML
  • MD - Markdown
parent
string or null <uuid> (Parent Group)
public_permissions
Array of strings

Responses

Request samples

Content type
{
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
  • "public_permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
  • "children": [
    ],
  • "textbooks": [
    ],
  • "courses": [
    ],
  • "links": [
    ],
  • "owner": "string",
  • "public_permissions": [
    ],
  • "role_assignments": [
    ],
  • "enrollment_methods": [
    ],
  • "access_requests": [
    ],
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Delete

Library Groups

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Library Group.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Textbook Pages

List

Textbook Pages

Authorizations:
SessionAuthentication
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

_page
integer

A page number within the paginated result set.

_page_size
integer

Number of results to return per page.

_search
string

A search term.

_sort
string

Which field to use when ordering the results.

created_at
string <date-time>
created_at__gte
string <date-time>
created_at__lte
string <date-time>
created_by
string
modified_at
string <date-time>
modified_at__gte
string <date-time>
modified_at__lte
string <date-time>
modified_by
string
name
string
parent
string <uuid>
position
integer
position__gte
integer
position__lte
integer
textbook
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?_page=4",
  • "previous": "http://api.example.org/accounts/?_page=2",
  • "results": [
    ]
}

Create

Textbook Pages

Authorizations:
SessionAuthentication
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
required
textbook
required
string <uuid>
parent
string or null <uuid> (Parent Page)
position
integer <int64> [ 0 .. 9223372036854776000 ]
Default: 0

Position among siblings in ascending order.

name
required
string <= 255 characters
description
string
text_format
string (TextFormatEnum)
Enum: "TEXT" "HTML" "MD"
  • TEXT - Plain Text
  • HTML - HTML
  • MD - Markdown
content
any (Content Tree)

DOM-like content tree with text and interactive components.

Responses

Request samples

Content type
{
  • "textbook": "9ec8aad7-8b6d-44a2-8a0f-6a86ccf0f1fb",
  • "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
  • "position": 0,
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "content": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "textbook": "9ec8aad7-8b6d-44a2-8a0f-6a86ccf0f1fb",
  • "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
  • "children": [
    ],
  • "position": 0,
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "content": null,
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Retrieve

Textbook Pages

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Textbook Page.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "textbook": "9ec8aad7-8b6d-44a2-8a0f-6a86ccf0f1fb",
  • "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
  • "children": [
    ],
  • "position": 0,
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "content": null,
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Update

Textbook Pages

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Textbook Page.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
required
textbook
required
string <uuid>
parent
string or null <uuid> (Parent Page)
position
integer <int64> [ 0 .. 9223372036854776000 ]
Default: 0

Position among siblings in ascending order.

name
required
string <= 255 characters
description
string
text_format
string (TextFormatEnum)
Enum: "TEXT" "HTML" "MD"
  • TEXT - Plain Text
  • HTML - HTML
  • MD - Markdown
content
any (Content Tree)

DOM-like content tree with text and interactive components.

Responses

Request samples

Content type
{
  • "textbook": "9ec8aad7-8b6d-44a2-8a0f-6a86ccf0f1fb",
  • "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
  • "position": 0,
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "content": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "textbook": "9ec8aad7-8b6d-44a2-8a0f-6a86ccf0f1fb",
  • "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
  • "children": [
    ],
  • "position": 0,
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "content": null,
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Partial Update

Textbook Pages

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Textbook Page.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
textbook
string <uuid>
parent
string or null <uuid> (Parent Page)
position
integer <int64> [ 0 .. 9223372036854776000 ]
Default: 0

Position among siblings in ascending order.

name
string <= 255 characters
description
string
text_format
string (TextFormatEnum)
Enum: "TEXT" "HTML" "MD"
  • TEXT - Plain Text
  • HTML - HTML
  • MD - Markdown
content
any (Content Tree)

DOM-like content tree with text and interactive components.

Responses

Request samples

Content type
{
  • "textbook": "9ec8aad7-8b6d-44a2-8a0f-6a86ccf0f1fb",
  • "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
  • "position": 0,
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "content": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "textbook": "9ec8aad7-8b6d-44a2-8a0f-6a86ccf0f1fb",
  • "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
  • "children": [
    ],
  • "position": 0,
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "content": null,
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Delete

Textbook Pages

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Textbook Page.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Textbooks

List

Textbooks

Authorizations:
SessionAuthenticationNone
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

_page
integer

A page number within the paginated result set.

_page_size
integer

Number of results to return per page.

_search
string

A search term.

_sort
string

Which field to use when ordering the results.

created_at
string <date-time>
created_at__gte
string <date-time>
created_at__lte
string <date-time>
created_by
string
group
string <uuid>
modified_at
string <date-time>
modified_at__gte
string <date-time>
modified_at__lte
string <date-time>
modified_by
string
name
string
slug
string

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?_page=4",
  • "previous": "http://api.example.org/accounts/?_page=2",
  • "results": [
    ]
}

Create

Textbooks

Authorizations:
SessionAuthentication
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
required
slug
required
string <= 50 characters ^[-a-zA-Z0-9_]+$
name
required
string <= 255 characters
description
string
text_format
string (TextFormatEnum)
Enum: "TEXT" "HTML" "MD"
  • TEXT - Plain Text
  • HTML - HTML
  • MD - Markdown
group
required
string <uuid> (Library Group)

Responses

Request samples

Content type
{
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
  • "pages": [
    ],
  • "used_in_courses": [
    ],
  • "library_links": [
    ],
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Retrieve

Textbooks

Authorizations:
SessionAuthenticationNone
path Parameters
id
required
string <uuid>

A UUID string identifying this Textbook.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
  • "pages": [
    ],
  • "used_in_courses": [
    ],
  • "library_links": [
    ],
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Update

Textbooks

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Textbook.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
required
slug
required
string <= 50 characters ^[-a-zA-Z0-9_]+$
name
required
string <= 255 characters
description
string
text_format
string (TextFormatEnum)
Enum: "TEXT" "HTML" "MD"
  • TEXT - Plain Text
  • HTML - HTML
  • MD - Markdown
group
required
string <uuid> (Library Group)

Responses

Request samples

Content type
{
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
  • "pages": [
    ],
  • "used_in_courses": [
    ],
  • "library_links": [
    ],
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Partial Update

Textbooks

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Textbook.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
slug
string <= 50 characters ^[-a-zA-Z0-9_]+$
name
string <= 255 characters
description
string
text_format
string (TextFormatEnum)
Enum: "TEXT" "HTML" "MD"
  • TEXT - Plain Text
  • HTML - HTML
  • MD - Markdown
group
string <uuid> (Library Group)

Responses

Request samples

Content type
{
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
  • "pages": [
    ],
  • "used_in_courses": [
    ],
  • "library_links": [
    ],
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Delete

Textbooks

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Textbook.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Courses

List

Courses

Authorizations:
SessionAuthenticationNone
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

_page
integer

A page number within the paginated result set.

_page_size
integer

Number of results to return per page.

_search
string

A search term.

_sort
string

Which field to use when ordering the results.

created_at
string <date-time>
created_at__gte
string <date-time>
created_at__lte
string <date-time>
created_by
string
group
string <uuid>
is_template
boolean
modified_at
string <date-time>
modified_at__gte
string <date-time>
modified_at__lte
string <date-time>
modified_by
string
name
string
owner
integer
slug
string

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?_page=4",
  • "previous": "http://api.example.org/accounts/?_page=2",
  • "results": [
    ]
}

Create

Courses

Authorizations:
SessionAuthentication
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
required
slug
required
string <= 50 characters ^[-a-zA-Z0-9_]+$
name
required
string <= 255 characters
description
string
text_format
string (TextFormatEnum)
Enum: "TEXT" "HTML" "MD"
  • TEXT - Plain Text
  • HTML - HTML
  • MD - Markdown
group
required
string <uuid> (Library Group)
is_template
boolean

Flag that this course is only used for creating other courses.

public_permissions
required
Array of strings

Responses

Request samples

Content type
{
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
  • "is_template": true,
  • "public_permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
  • "is_template": true,
  • "materials": [
    ],
  • "owner": "string",
  • "public_permissions": [
    ],
  • "role_assignments": [
    ],
  • "enrollment_methods": [
    ],
  • "access_requests": [
    ],
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Retrieve

Courses

Authorizations:
SessionAuthenticationNone
path Parameters
id
required
string <uuid>

A UUID string identifying this Course.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
  • "is_template": true,
  • "materials": [
    ],
  • "owner": "string",
  • "public_permissions": [
    ],
  • "role_assignments": [
    ],
  • "enrollment_methods": [
    ],
  • "access_requests": [
    ],
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Update

Courses

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Course.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
required
slug
required
string <= 50 characters ^[-a-zA-Z0-9_]+$
name
required
string <= 255 characters
description
string
text_format
string (TextFormatEnum)
Enum: "TEXT" "HTML" "MD"
  • TEXT - Plain Text
  • HTML - HTML
  • MD - Markdown
group
required
string <uuid> (Library Group)
is_template
boolean

Flag that this course is only used for creating other courses.

public_permissions
required
Array of strings

Responses

Request samples

Content type
{
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
  • "is_template": true,
  • "public_permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
  • "is_template": true,
  • "materials": [
    ],
  • "owner": "string",
  • "public_permissions": [
    ],
  • "role_assignments": [
    ],
  • "enrollment_methods": [
    ],
  • "access_requests": [
    ],
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Partial Update

Courses

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Course.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
slug
string <= 50 characters ^[-a-zA-Z0-9_]+$
name
string <= 255 characters
description
string
text_format
string (TextFormatEnum)
Enum: "TEXT" "HTML" "MD"
  • TEXT - Plain Text
  • HTML - HTML
  • MD - Markdown
group
string <uuid> (Library Group)
is_template
boolean

Flag that this course is only used for creating other courses.

public_permissions
Array of strings

Responses

Request samples

Content type
{
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
  • "is_template": true,
  • "public_permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
  • "is_template": true,
  • "materials": [
    ],
  • "owner": "string",
  • "public_permissions": [
    ],
  • "role_assignments": [
    ],
  • "enrollment_methods": [
    ],
  • "access_requests": [
    ],
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Delete

Courses

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Course.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Available Languages

List

Allow unrestricted access to the list and retrieve actions.

This small view set mixin class allows unrestricted access to the list and retrieve actions while deferring permission checks for all other actions to the permission classes of the view set (usually defined in settings.py).

Authorizations:
SessionAuthenticationNone
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

_page
integer

A page number within the paginated result set.

_page_size
integer

Number of results to return per page.

_search
string

A search term.

_sort
string

Which field to use when ordering the results.

name
string

Responses

Response samples

Content type
application/json
{}

Retrieve

Allow unrestricted access to the list and retrieve actions.

This small view set mixin class allows unrestricted access to the list and retrieve actions while deferring permission checks for all other actions to the permission classes of the view set (usually defined in settings.py).

Authorizations:
SessionAuthenticationNone
path Parameters
language
required
string (Language Code)

A unique value identifying this language.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Response samples

Content type
application/json
{
  • "language": "str",
  • "name": "string"
}

HTML Component Definitions

List

HTML Libraries

Authorizations:
SessionAuthenticationNone
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

_page
integer

A page number within the paginated result set.

_page_size
integer

Number of results to return per page.

_search
string

A search term.

_sort
string

Which field to use when ordering the results.

html_component__library__author__icontains
string
html_component__library__name__icontains
string
html_component__library__organization__icontains
string
html_component__tag_name__icontains
string
library_version__version
string

Responses

Response samples

Content type
application/json
{}

Retrieve

HTML Libraries

Authorizations:
SessionAuthenticationNone
path Parameters
id
required
string <uuid>

A UUID string identifying this HTML Component Definition.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "html_component": "c59f3a17-3034-4c01-b4d2-85fbb016d450",
  • "library_version": "580f26c6-5fae-4a47-996d-9009a4929f04",
  • "definition": null
}

HTML Components

List

HTML Libraries

Authorizations:
SessionAuthenticationNone
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

_page
integer

A page number within the paginated result set.

_page_size
integer

Number of results to return per page.

_search
string

A search term.

_sort
string

Which field to use when ordering the results.

library__author__icontains
string
library__name__icontains
string
library__organization__icontains
string
tag_name__icontains
string

Responses

Response samples

Content type
application/json
{}

Retrieve

HTML Libraries

Authorizations:
SessionAuthenticationNone
path Parameters
id
required
string <uuid>

A UUID string identifying this HTML Component.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "library": "797da83b-59ce-49a1-b907-6b3b0f54a6f5",
  • "tag_name": "string",
  • "definitions": [
    ]
}

HTML Libraries

List

HTML Libraries

Authorizations:
SessionAuthenticationNone
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

_page
integer

A page number within the paginated result set.

_page_size
integer

Number of results to return per page.

_search
string

A search term.

_sort
string

Which field to use when ordering the results.

author__icontains
string
created_at
string <date-time>
created_at__gte
string <date-time>
created_at__lte
string <date-time>
created_by
integer
license__icontains
string
modified_at
string <date-time>
modified_at__gte
string <date-time>
modified_at__lte
string <date-time>
modified_by
integer
name__icontains
string
organization__icontains
string
published
boolean

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?_page=4",
  • "previous": "http://api.example.org/accounts/?_page=2",
  • "results": [
    ]
}

Retrieve

HTML Libraries

Authorizations:
SessionAuthenticationNone
path Parameters
id
required
string <uuid>

A UUID string identifying this HTML Library.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "fqn": "string",
  • "organization": "string",
  • "name": "string",
  • "author": "string",
  • "license": "string",
  • "website": "http://example.com",
  • "coderepo": "http://example.com",
  • "bugtracker": "http://example.com",
  • "readme": "string",
  • "text_format": "TEXT",
  • "published": true,
  • "translations": [
    ],
  • "versions": [
    ],
  • "components": [
    ],
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

HTML Library Texts

List

HTML Libraries Texts

Authorizations:
SessionAuthenticationNone
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

_page
integer

A page number within the paginated result set.

_page_size
integer

Number of results to return per page.

_search
string

A search term.

_sort
string

Which field to use when ordering the results.

language
string (Language Code)
parent__author__icontains
string
parent__id
string <uuid>
parent__name__icontains
string
parent__organization__icontains
string
short_description__icontains
string

Responses

Response samples

Content type
application/json
{}

Retrieve

HTML Libraries Texts

Authorizations:
SessionAuthenticationNone
path Parameters
id
required
string <uuid>

A UUID string identifying this HTML Library Text.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
  • "language": "string",
  • "short_description": "string"
}

HTML Library Versions

List

HTML Library Versions

Authorizations:
SessionAuthenticationNone
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

_page
integer

A page number within the paginated result set.

_page_size
integer

Number of results to return per page.

_search
string

A search term.

_sort
string

Which field to use when ordering the results.

created_at
string <date-time>
created_at__gte
string <date-time>
created_at__lte
string <date-time>
created_by
integer
modified_at
string <date-time>
modified_at__gte
string <date-time>
modified_at__lte
string <date-time>
modified_by
integer
parent__author__icontains
string
parent__id
string <uuid>
parent__name__icontains
string
parent__organization__icontains
string
version__icontains
string

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?_page=4",
  • "previous": "http://api.example.org/accounts/?_page=2",
  • "results": [
    ]
}

Retrieve

HTML Library Versions

Authorizations:
SessionAuthenticationNone
path Parameters
id
required
string <uuid>

A UUID string identifying this HTML Library Version.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
  • "version": "string",
  • "dependencies": null,
  • "frontend_url": "string",
  • "file_data": "http://example.com",
  • "file_name": "string",
  • "file_size": 9223372036854776000,
  • "mime_type": "string",
  • "components": [
    ],
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Media Files

List

Attached Media Files

Authorizations:
SessionAuthentication
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

_page
integer

A page number within the paginated result set.

_page_size
integer

Number of results to return per page.

_search
string

A search term.

_sort
string

Which field to use when ordering the results.

content_type
integer
file_name
string
file_size
integer
mime_type
string
object_id
string <uuid>

Responses

Response samples

Content type
application/json
{}

Create

Attached Media Files

Authorizations:
SessionAuthentication
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
required
content_type
required
integer
object_id
required
string <uuid>
file_name
string <= 255 characters
file_size
integer or null <int64> [ 0 .. 9223372036854776000 ]
mime_type
string <= 64 characters
file_data
string <uri>

Responses

Request samples

Content type
{
  • "content_type": 0,
  • "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  • "file_name": "string",
  • "file_size": 9223372036854776000,
  • "mime_type": "string",
  • "file_data": "http://example.com"
}

Response samples

Content type
application/json
{
  • "content_type": 0,
  • "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  • "file_name": "string",
  • "file_size": 9223372036854776000,
  • "mime_type": "string",
  • "file_data": "http://example.com"
}

Retrieve

Attached Media Files

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Media File.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Response samples

Content type
application/json
{
  • "content_type": 0,
  • "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  • "file_name": "string",
  • "file_size": 9223372036854776000,
  • "mime_type": "string",
  • "file_data": "http://example.com"
}

Update

Attached Media Files

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Media File.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
required
content_type
required
integer
object_id
required
string <uuid>
file_name
string <= 255 characters
file_size
integer or null <int64> [ 0 .. 9223372036854776000 ]
mime_type
string <= 64 characters
file_data
string <uri>

Responses

Request samples

Content type
{
  • "content_type": 0,
  • "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  • "file_name": "string",
  • "file_size": 9223372036854776000,
  • "mime_type": "string",
  • "file_data": "http://example.com"
}

Response samples

Content type
application/json
{
  • "content_type": 0,
  • "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  • "file_name": "string",
  • "file_size": 9223372036854776000,
  • "mime_type": "string",
  • "file_data": "http://example.com"
}

Partial Update

Attached Media Files

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Media File.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
content_type
integer
object_id
string <uuid>
file_name
string <= 255 characters
file_size
integer or null <int64> [ 0 .. 9223372036854776000 ]
mime_type
string <= 64 characters
file_data
string <uri>

Responses

Request samples

Content type
{
  • "content_type": 0,
  • "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  • "file_name": "string",
  • "file_size": 9223372036854776000,
  • "mime_type": "string",
  • "file_data": "http://example.com"
}

Response samples

Content type
application/json
{
  • "content_type": 0,
  • "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  • "file_name": "string",
  • "file_size": 9223372036854776000,
  • "mime_type": "string",
  • "file_data": "http://example.com"
}

Delete

Attached Media Files

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Media File.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Websites

List

General Website Settings

Authorizations:
SessionAuthenticationNone
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

_page
integer

A page number within the paginated result set.

_page_size
integer

Number of results to return per page.

_search
string

A search term.

_sort
string

Which field to use when ordering the results.

domain
string
name
string
short_name
string

Responses

Response samples

Content type
application/json
{}

Retrieve

General Website Settings

Authorizations:
SessionAuthenticationNone
path Parameters
id
required
integer

A unique integer value identifying this Website.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "domain": "string",
  • "name": "string",
  • "short_name": "string",
  • "about_url": "http://example.com",
  • "brand_color": "string",
  • "auth_config": 0
}

Health Status

Return a simple health status that the API is up and running.

Authorizations:
SessionAuthenticationNone
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Access Requests

List

Access requests to get a scoped role assigned

Authorizations:
SessionAuthentication
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

_page
integer

A page number within the paginated result set.

_page_size
integer

Number of results to return per page.

_search
string

A search term.

_sort
string

Which field to use when ordering the results.

created_at
string <date-time>
created_at__gte
string <date-time>
created_at__lte
string <date-time>
created_by
string
decision
string
Enum: "accepted" "denied" "pending"
  • pending - Decision Pending
  • accepted - Accepted
  • denied - Denied
decision_date
string <date-time>
decision_date__gte
string <date-time>
decision_date__lte
string <date-time>
modified_at
string <date-time>
modified_at__gte
string <date-time>
modified_at__lte
string <date-time>
modified_by
string
role
string
scope_type
integer
scope_uuid
string <uuid>
user
string

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?_page=4",
  • "previous": "http://api.example.org/accounts/?_page=2",
  • "results": [
    ]
}

Create

Access requests to get a scoped role assigned

Authorizations:
SessionAuthentication
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
required
scope_type
required
string
scope_uuid
required
string <uuid>
user
required
string
role
required
string
end_date
string or null <date-time> (Enrollment Ends on)
DurationPeriodEnum (string) or BlankEnum (any)
duration_value
number <double>
decision
string (DecisionEnum)
Enum: "pending" "accepted" "denied"
  • pending - Decision Pending
  • accepted - Accepted
  • denied - Denied

Responses

Request samples

Content type
{
  • "scope_type": "string",
  • "scope_uuid": "2bbb55e9-6cd6-4634-8601-f866a43d07dd",
  • "user": "string",
  • "role": "string",
  • "end_date": "2019-08-24T14:15:22Z",
  • "duration_period": "minutes",
  • "duration_value": 0.1,
  • "decision": "pending"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "scope_type": "string",
  • "scope_uuid": "2bbb55e9-6cd6-4634-8601-f866a43d07dd",
  • "user": "string",
  • "role": "string",
  • "end_date": "2019-08-24T14:15:22Z",
  • "duration_period": "minutes",
  • "duration_value": 0.1,
  • "decision": "pending",
  • "decision_date": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Retrieve

Access requests to get a scoped role assigned

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Access Request.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "scope_type": "string",
  • "scope_uuid": "2bbb55e9-6cd6-4634-8601-f866a43d07dd",
  • "user": "string",
  • "role": "string",
  • "end_date": "2019-08-24T14:15:22Z",
  • "duration_period": "minutes",
  • "duration_value": 0.1,
  • "decision": "pending",
  • "decision_date": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Update

Access requests to get a scoped role assigned

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Access Request.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
required
scope_type
required
string
scope_uuid
required
string <uuid>
user
required
string
role
required
string
end_date
string or null <date-time> (Enrollment Ends on)
DurationPeriodEnum (string) or BlankEnum (any)
duration_value
number <double>
decision
string (DecisionEnum)
Enum: "pending" "accepted" "denied"
  • pending - Decision Pending
  • accepted - Accepted
  • denied - Denied

Responses

Request samples

Content type
{
  • "scope_type": "string",
  • "scope_uuid": "2bbb55e9-6cd6-4634-8601-f866a43d07dd",
  • "user": "string",
  • "role": "string",
  • "end_date": "2019-08-24T14:15:22Z",
  • "duration_period": "minutes",
  • "duration_value": 0.1,
  • "decision": "pending"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "scope_type": "string",
  • "scope_uuid": "2bbb55e9-6cd6-4634-8601-f866a43d07dd",
  • "user": "string",
  • "role": "string",
  • "end_date": "2019-08-24T14:15:22Z",
  • "duration_period": "minutes",
  • "duration_value": 0.1,
  • "decision": "pending",
  • "decision_date": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Partial Update

Access requests to get a scoped role assigned

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Access Request.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
scope_type
string
scope_uuid
string <uuid>
user
string
role
string
end_date
string or null <date-time> (Enrollment Ends on)
DurationPeriodEnum (string) or BlankEnum (any)
duration_value
number <double>
decision
string (DecisionEnum)
Enum: "pending" "accepted" "denied"
  • pending - Decision Pending
  • accepted - Accepted
  • denied - Denied

Responses

Request samples

Content type
{
  • "scope_type": "string",
  • "scope_uuid": "2bbb55e9-6cd6-4634-8601-f866a43d07dd",
  • "user": "string",
  • "role": "string",
  • "end_date": "2019-08-24T14:15:22Z",
  • "duration_period": "minutes",
  • "duration_value": 0.1,
  • "decision": "pending"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "scope_type": "string",
  • "scope_uuid": "2bbb55e9-6cd6-4634-8601-f866a43d07dd",
  • "user": "string",
  • "role": "string",
  • "end_date": "2019-08-24T14:15:22Z",
  • "duration_period": "minutes",
  • "duration_value": 0.1,
  • "decision": "pending",
  • "decision_date": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Delete

Access requests to get a scoped role assigned

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Access Request.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Accept

Accept the request.

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Access Request.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "scope_type": "string",
  • "scope_uuid": "2bbb55e9-6cd6-4634-8601-f866a43d07dd",
  • "user": "string",
  • "role": "string",
  • "end_date": "2019-08-24T14:15:22Z",
  • "duration_period": "minutes",
  • "duration_value": 0.1,
  • "decision": "pending",
  • "decision_date": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Deny

Deny the request.

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Access Request.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "scope_type": "string",
  • "scope_uuid": "2bbb55e9-6cd6-4634-8601-f866a43d07dd",
  • "user": "string",
  • "role": "string",
  • "end_date": "2019-08-24T14:15:22Z",
  • "duration_period": "minutes",
  • "duration_value": 0.1,
  • "decision": "pending",
  • "decision_date": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Allowed Role Permissions

List

Allowed permissions for the roles of a given scope type

Authorizations:
SessionAuthenticationNone
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

_page
integer

A page number within the paginated result set.

_page_size
integer

Number of results to return per page.

_search
string

A search term.

_sort
string

Which field to use when ordering the results.

permission
integer
scope_type
integer

Responses

Response samples

Content type
application/json
{}

Retrieve

Allowed permissions for the roles of a given scope type

Authorizations:
SessionAuthenticationNone
path Parameters
id
required
string <uuid>

A UUID string identifying this Allowed Role Permission.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "scope_type": "string",
  • "permission": "string"
}

Authentication Tokens

List

Provide authentication tokens for remote clients.

Authentication tokens provide an authentication mechanism for remote clients without giving them a username and password. This allows human users to grant access (in their name) to other apps, though those apps then impersonate these users. More importantly, this allows creating special technical app users for which the access token is the only allowed authentication mechanism.

Authorizations:
SessionAuthentication
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

_page
integer

A page number within the paginated result set.

_page_size
integer

Number of results to return per page.

_search
string

A search term.

_sort
string

Which field to use when ordering the results.

created_at
string <date-time>
created_at__gte
string <date-time>
created_at__lte
string <date-time>
created_by
string
end_date
string <date-time>
end_date__gte
string <date-time>
end_date__lte
string <date-time>
is_active
boolean
modified_at
string <date-time>
modified_at__gte
string <date-time>
modified_at__lte
string <date-time>
modified_by
string
start_date
string <date-time>
start_date__gte
string <date-time>
start_date__lte
string <date-time>
user
string

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?_page=4",
  • "previous": "http://api.example.org/accounts/?_page=2",
  • "results": [
    ]
}

Create

Provide authentication tokens for remote clients.

Authentication tokens provide an authentication mechanism for remote clients without giving them a username and password. This allows human users to grant access (in their name) to other apps, though those apps then impersonate these users. More importantly, this allows creating special technical app users for which the access token is the only allowed authentication mechanism.

Authorizations:
SessionAuthentication
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
required
user
required
string
name
required
string <= 255 characters
description
string
text_format
string (TextFormatEnum)
Enum: "TEXT" "HTML" "MD"
  • TEXT - Plain Text
  • HTML - HTML
  • MD - Markdown
is_active
boolean (Active)
start_date
string or null <date-time> (Start date and time)
end_date
string or null <date-time> (End date and time)

Responses

Request samples

Content type
{
  • "user": "string",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "is_active": true,
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user": "string",
  • "token": "string",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "is_active": true,
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Retrieve

Provide authentication tokens for remote clients.

Authentication tokens provide an authentication mechanism for remote clients without giving them a username and password. This allows human users to grant access (in their name) to other apps, though those apps then impersonate these users. More importantly, this allows creating special technical app users for which the access token is the only allowed authentication mechanism.

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Authentication Token.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user": "string",
  • "token": "string",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "is_active": true,
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Update

Provide authentication tokens for remote clients.

Authentication tokens provide an authentication mechanism for remote clients without giving them a username and password. This allows human users to grant access (in their name) to other apps, though those apps then impersonate these users. More importantly, this allows creating special technical app users for which the access token is the only allowed authentication mechanism.

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Authentication Token.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
required
name
required
string <= 255 characters
description
string
text_format
string (TextFormatEnum)
Enum: "TEXT" "HTML" "MD"
  • TEXT - Plain Text
  • HTML - HTML
  • MD - Markdown
is_active
boolean (Active)
start_date
string or null <date-time> (Start date and time)
end_date
string or null <date-time> (End date and time)

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "is_active": true,
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user": "string",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "is_active": true,
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z"
}

Partial Update

Provide authentication tokens for remote clients.

Authentication tokens provide an authentication mechanism for remote clients without giving them a username and password. This allows human users to grant access (in their name) to other apps, though those apps then impersonate these users. More importantly, this allows creating special technical app users for which the access token is the only allowed authentication mechanism.

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Authentication Token.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
name
string <= 255 characters
description
string
text_format
string (TextFormatEnum)
Enum: "TEXT" "HTML" "MD"
  • TEXT - Plain Text
  • HTML - HTML
  • MD - Markdown
is_active
boolean (Active)
start_date
string or null <date-time> (Start date and time)
end_date
string or null <date-time> (End date and time)

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "is_active": true,
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user": "string",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "is_active": true,
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z"
}

Delete

Provide authentication tokens for remote clients.

Authentication tokens provide an authentication mechanism for remote clients without giving them a username and password. This allows human users to grant access (in their name) to other apps, though those apps then impersonate these users. More importantly, this allows creating special technical app users for which the access token is the only allowed authentication mechanism.

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Authentication Token.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Current User

Retrieve

Returns the currently authenticated user or a fallback response.

Authorizations:
SessionAuthenticationNone
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

_page
integer

A page number within the paginated result set.

_page_size
integer

Number of results to return per page.

_search
string

A search term.

_sort
string

Which field to use when ordering the results.

Responses

Response samples

Content type
application/json
{}

Create

Current User

Authorizations:
SessionAuthenticationNone
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
required
username
required
string <= 150 characters ^[\w.@+-]+$

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

first_name
string <= 150 characters
last_name
string <= 150 characters
description
string
picture
string or null <uri> (Profile Picture)
is_staff
boolean (Staff status)

Designates whether the user can log into this admin site.

last_login
string or null <date-time>
date_joined
string <date-time>
email
required
string <email> (E-Mail Address) <= 254 characters

Responses

Request samples

Content type
{
  • "username": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "description": "string",
  • "picture": "http://example.com",
  • "is_staff": true,
  • "last_login": "2019-08-24T14:15:22Z",
  • "date_joined": "2019-08-24T14:15:22Z",
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "username": "string",
  • "full_name": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "description": "string",
  • "picture": "http://example.com",
  • "is_staff": true,
  • "last_login": "2019-08-24T14:15:22Z",
  • "date_joined": "2019-08-24T14:15:22Z",
  • "email": "user@example.com",
  • "is_authenticated": true
}

Update

Current User

Authorizations:
SessionAuthenticationNone
path Parameters
id
required
integer

A unique integer value identifying this user.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
required
username
required
string <= 150 characters ^[\w.@+-]+$

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

first_name
string <= 150 characters
last_name
string <= 150 characters
description
string
picture
string or null <uri> (Profile Picture)
is_staff
boolean (Staff status)

Designates whether the user can log into this admin site.

last_login
string or null <date-time>
date_joined
string <date-time>
email
required
string <email> (E-Mail Address) <= 254 characters

Responses

Request samples

Content type
{
  • "username": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "description": "string",
  • "picture": "http://example.com",
  • "is_staff": true,
  • "last_login": "2019-08-24T14:15:22Z",
  • "date_joined": "2019-08-24T14:15:22Z",
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "username": "string",
  • "full_name": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "description": "string",
  • "picture": "http://example.com",
  • "is_staff": true,
  • "last_login": "2019-08-24T14:15:22Z",
  • "date_joined": "2019-08-24T14:15:22Z",
  • "email": "user@example.com",
  • "is_authenticated": true
}

Partial Update

Current User

Authorizations:
SessionAuthenticationNone
path Parameters
id
required
integer

A unique integer value identifying this user.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
username
string <= 150 characters ^[\w.@+-]+$

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

first_name
string <= 150 characters
last_name
string <= 150 characters
description
string
picture
string or null <uri> (Profile Picture)
is_staff
boolean (Staff status)

Designates whether the user can log into this admin site.

last_login
string or null <date-time>
date_joined
string <date-time>
email
string <email> (E-Mail Address) <= 254 characters

Responses

Request samples

Content type
{
  • "username": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "description": "string",
  • "picture": "http://example.com",
  • "is_staff": true,
  • "last_login": "2019-08-24T14:15:22Z",
  • "date_joined": "2019-08-24T14:15:22Z",
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "username": "string",
  • "full_name": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "description": "string",
  • "picture": "http://example.com",
  • "is_staff": true,
  • "last_login": "2019-08-24T14:15:22Z",
  • "date_joined": "2019-08-24T14:15:22Z",
  • "email": "user@example.com",
  • "is_authenticated": true
}

Delete

Current User

Authorizations:
SessionAuthenticationNone
path Parameters
id
required
integer

A unique integer value identifying this user.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Enrollment Methods

List

Enrollment methods for self-registration

Authorizations:
SessionAuthentication
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

_page
integer

A page number within the paginated result set.

_page_size
integer

Number of results to return per page.

_search
string

A search term.

_sort
string

Which field to use when ordering the results.

created_at
string <date-time>
created_at__gte
string <date-time>
created_at__lte
string <date-time>
created_by
string
is_active
boolean
modified_at
string <date-time>
modified_at__gte
string <date-time>
modified_at__lte
string <date-time>
modified_by
string
name
string
role
string
scope_type
integer
scope_uuid
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?_page=4",
  • "previous": "http://api.example.org/accounts/?_page=2",
  • "results": [
    ]
}

Create

Enrollment methods for self-registration

Authorizations:
SessionAuthentication
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
required
scope_type
required
string
scope_uuid
required
string <uuid>
name
required
string <= 255 characters
description
string
text_format
string (TextFormatEnum)
Enum: "TEXT" "HTML" "MD"
  • TEXT - Plain Text
  • HTML - HTML
  • MD - Markdown
role
required
string
end_date
string or null <date-time> (Enrollment Ends on)
DurationPeriodEnum (string) or BlankEnum (any)
duration_value
number <double>
passphrase
string <= 100 characters
is_active
boolean (Active)

Responses

Request samples

Content type
{
  • "scope_type": "string",
  • "scope_uuid": "2bbb55e9-6cd6-4634-8601-f866a43d07dd",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "role": "string",
  • "end_date": "2019-08-24T14:15:22Z",
  • "duration_period": "minutes",
  • "duration_value": 0.1,
  • "passphrase": "string",
  • "is_active": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "scope_type": "string",
  • "scope_uuid": "2bbb55e9-6cd6-4634-8601-f866a43d07dd",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "role": "string",
  • "end_date": "2019-08-24T14:15:22Z",
  • "duration_period": "minutes",
  • "duration_value": 0.1,
  • "passphrase": "string",
  • "is_active": true,
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Retrieve

Enrollment methods for self-registration

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Enrollment Method.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "scope_type": "string",
  • "scope_uuid": "2bbb55e9-6cd6-4634-8601-f866a43d07dd",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "role": "string",
  • "end_date": "2019-08-24T14:15:22Z",
  • "duration_period": "minutes",
  • "duration_value": 0.1,
  • "passphrase": "string",
  • "is_active": true,
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Update

Enrollment methods for self-registration

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Enrollment Method.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
required
scope_type
required
string
scope_uuid
required
string <uuid>
name
required
string <= 255 characters
description
string
text_format
string (TextFormatEnum)
Enum: "TEXT" "HTML" "MD"
  • TEXT - Plain Text
  • HTML - HTML
  • MD - Markdown
role
required
string
end_date
string or null <date-time> (Enrollment Ends on)
DurationPeriodEnum (string) or BlankEnum (any)
duration_value
number <double>
passphrase
string <= 100 characters
is_active
boolean (Active)

Responses

Request samples

Content type
{
  • "scope_type": "string",
  • "scope_uuid": "2bbb55e9-6cd6-4634-8601-f866a43d07dd",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "role": "string",
  • "end_date": "2019-08-24T14:15:22Z",
  • "duration_period": "minutes",
  • "duration_value": 0.1,
  • "passphrase": "string",
  • "is_active": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "scope_type": "string",
  • "scope_uuid": "2bbb55e9-6cd6-4634-8601-f866a43d07dd",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "role": "string",
  • "end_date": "2019-08-24T14:15:22Z",
  • "duration_period": "minutes",
  • "duration_value": 0.1,
  • "passphrase": "string",
  • "is_active": true,
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Partial Update

Enrollment methods for self-registration

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Enrollment Method.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
scope_type
string
scope_uuid
string <uuid>
name
string <= 255 characters
description
string
text_format
string (TextFormatEnum)
Enum: "TEXT" "HTML" "MD"
  • TEXT - Plain Text
  • HTML - HTML
  • MD - Markdown
role
string
end_date
string or null <date-time> (Enrollment Ends on)
DurationPeriodEnum (string) or BlankEnum (any)
duration_value
number <double>
passphrase
string <= 100 characters
is_active
boolean (Active)

Responses

Request samples

Content type
{
  • "scope_type": "string",
  • "scope_uuid": "2bbb55e9-6cd6-4634-8601-f866a43d07dd",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "role": "string",
  • "end_date": "2019-08-24T14:15:22Z",
  • "duration_period": "minutes",
  • "duration_value": 0.1,
  • "passphrase": "string",
  • "is_active": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "scope_type": "string",
  • "scope_uuid": "2bbb55e9-6cd6-4634-8601-f866a43d07dd",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "role": "string",
  • "end_date": "2019-08-24T14:15:22Z",
  • "duration_period": "minutes",
  • "duration_value": 0.1,
  • "passphrase": "string",
  • "is_active": true,
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Delete

Enrollment methods for self-registration

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Enrollment Method.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Enroll User

Enroll the current user with the selected enrollment method.

Authorizations:
SessionAuthenticationNone
path Parameters
id
required
string <uuid>

A UUID string identifying this Enrollment Method.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
passphrase
string

Responses

Request samples

Content type
{
  • "passphrase": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "scope_type": "string",
  • "scope_uuid": "2bbb55e9-6cd6-4634-8601-f866a43d07dd",
  • "role": "string",
  • "user": "string",
  • "assignment_method": "manual",
  • "enrollment_method": "9db248fe-b76d-4161-a5e8-b8a4731d42bc",
  • "access_request": "0739d58c-5038-4957-9e0f-da20d109060e",
  • "is_active": true,
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Role Assignments

List

Users and their roles in a scope

Authorizations:
SessionAuthentication
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

_page
integer

A page number within the paginated result set.

_page_size
integer

Number of results to return per page.

_search
string

A search term.

_sort
string

Which field to use when ordering the results.

created_at
string <date-time>
created_at__gte
string <date-time>
created_at__lte
string <date-time>
created_by
string
end_date
string <date-time>
end_date__gte
string <date-time>
end_date__lte
string <date-time>
is_active
boolean
modified_at
string <date-time>
modified_at__gte
string <date-time>
modified_at__lte
string <date-time>
modified_by
string
role
string
scope_type
integer
scope_uuid
string <uuid>
start_date
string <date-time>
start_date__gte
string <date-time>
start_date__lte
string <date-time>
user
string

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?_page=4",
  • "previous": "http://api.example.org/accounts/?_page=2",
  • "results": [
    ]
}

Create

Users and their roles in a scope

Authorizations:
SessionAuthentication
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
required
scope_type
required
string
scope_uuid
required
string <uuid>
role
required
string
user
required
string
assignment_method
string (AssignmentMethodEnum)
Enum: "manual" "self-enrollment" "access-request"
  • manual - Manual Assignment
  • self-enrollment - Self-Enrollment
  • access-request - Access Request
enrollment_method
string or null <uuid>
access_request
string or null <uuid>
is_active
boolean (Active)
start_date
string or null <date-time> (Start date and time)
end_date
string or null <date-time> (End date and time)

Responses

Request samples

Content type
{
  • "scope_type": "string",
  • "scope_uuid": "2bbb55e9-6cd6-4634-8601-f866a43d07dd",
  • "role": "string",
  • "user": "string",
  • "assignment_method": "manual",
  • "enrollment_method": "9db248fe-b76d-4161-a5e8-b8a4731d42bc",
  • "access_request": "0739d58c-5038-4957-9e0f-da20d109060e",
  • "is_active": true,
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "scope_type": "string",
  • "scope_uuid": "2bbb55e9-6cd6-4634-8601-f866a43d07dd",
  • "role": "string",
  • "user": "string",
  • "assignment_method": "manual",
  • "enrollment_method": "9db248fe-b76d-4161-a5e8-b8a4731d42bc",
  • "access_request": "0739d58c-5038-4957-9e0f-da20d109060e",
  • "is_active": true,
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Retrieve

Users and their roles in a scope

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Role Assignment.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "scope_type": "string",
  • "scope_uuid": "2bbb55e9-6cd6-4634-8601-f866a43d07dd",
  • "role": "string",
  • "user": "string",
  • "assignment_method": "manual",
  • "enrollment_method": "9db248fe-b76d-4161-a5e8-b8a4731d42bc",
  • "access_request": "0739d58c-5038-4957-9e0f-da20d109060e",
  • "is_active": true,
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Update

Users and their roles in a scope

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Role Assignment.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
required
scope_type
required
string
scope_uuid
required
string <uuid>
role
required
string
user
required
string
assignment_method
string (AssignmentMethodEnum)
Enum: "manual" "self-enrollment" "access-request"
  • manual - Manual Assignment
  • self-enrollment - Self-Enrollment
  • access-request - Access Request
enrollment_method
string or null <uuid>
access_request
string or null <uuid>
is_active
boolean (Active)
start_date
string or null <date-time> (Start date and time)
end_date
string or null <date-time> (End date and time)

Responses

Request samples

Content type
{
  • "scope_type": "string",
  • "scope_uuid": "2bbb55e9-6cd6-4634-8601-f866a43d07dd",
  • "role": "string",
  • "user": "string",
  • "assignment_method": "manual",
  • "enrollment_method": "9db248fe-b76d-4161-a5e8-b8a4731d42bc",
  • "access_request": "0739d58c-5038-4957-9e0f-da20d109060e",
  • "is_active": true,
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "scope_type": "string",
  • "scope_uuid": "2bbb55e9-6cd6-4634-8601-f866a43d07dd",
  • "role": "string",
  • "user": "string",
  • "assignment_method": "manual",
  • "enrollment_method": "9db248fe-b76d-4161-a5e8-b8a4731d42bc",
  • "access_request": "0739d58c-5038-4957-9e0f-da20d109060e",
  • "is_active": true,
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Partial Update

Users and their roles in a scope

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Role Assignment.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
scope_type
string
scope_uuid
string <uuid>
role
string
user
string
assignment_method
string (AssignmentMethodEnum)
Enum: "manual" "self-enrollment" "access-request"
  • manual - Manual Assignment
  • self-enrollment - Self-Enrollment
  • access-request - Access Request
enrollment_method
string or null <uuid>
access_request
string or null <uuid>
is_active
boolean (Active)
start_date
string or null <date-time> (Start date and time)
end_date
string or null <date-time> (End date and time)

Responses

Request samples

Content type
{
  • "scope_type": "string",
  • "scope_uuid": "2bbb55e9-6cd6-4634-8601-f866a43d07dd",
  • "role": "string",
  • "user": "string",
  • "assignment_method": "manual",
  • "enrollment_method": "9db248fe-b76d-4161-a5e8-b8a4731d42bc",
  • "access_request": "0739d58c-5038-4957-9e0f-da20d109060e",
  • "is_active": true,
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "scope_type": "string",
  • "scope_uuid": "2bbb55e9-6cd6-4634-8601-f866a43d07dd",
  • "role": "string",
  • "user": "string",
  • "assignment_method": "manual",
  • "enrollment_method": "9db248fe-b76d-4161-a5e8-b8a4731d42bc",
  • "access_request": "0739d58c-5038-4957-9e0f-da20d109060e",
  • "is_active": true,
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Delete

Users and their roles in a scope

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Role Assignment.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Roles

List

User Roles Within a Scope

Authorizations:
SessionAuthentication
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

_page
integer

A page number within the paginated result set.

_page_size
integer

Number of results to return per page.

_search
string

A search term.

_sort
string

Which field to use when ordering the results.

created_at
string <date-time>
created_at__gte
string <date-time>
created_at__lte
string <date-time>
created_by
string
is_active
boolean
modified_at
string <date-time>
modified_at__gte
string <date-time>
modified_at__lte
string <date-time>
modified_by
string
name
string
priority
integer
priority__gte
integer
priority__lte
integer
scope_type
integer
scope_uuid
string <uuid>
slug
string

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?_page=4",
  • "previous": "http://api.example.org/accounts/?_page=2",
  • "results": [
    ]
}

Create

User Roles Within a Scope

Authorizations:
SessionAuthentication
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
required
scope_type
required
string
scope_uuid
required
string <uuid>
slug
required
string <= 50 characters ^[-a-zA-Z0-9_]+$
name
required
string <= 255 characters
description
string
text_format
string (TextFormatEnum)
Enum: "TEXT" "HTML" "MD"
  • TEXT - Plain Text
  • HTML - HTML
  • MD - Markdown
priority
required
integer <int64> [ 0 .. 9223372036854776000 ]

Low values mean less privileges. Make sure to correctly prioritize the rolls to avoid privilege escalation.

is_active
boolean (Active)
permissions
required
Array of strings
role_assignments
required
Array of strings <uuid> [ items <uuid > ]
enrollment_methods
required
Array of strings <uuid> [ items <uuid > ]
access_requests
required
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "scope_type": "string",
  • "scope_uuid": "2bbb55e9-6cd6-4634-8601-f866a43d07dd",
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "priority": 9223372036854776000,
  • "is_active": true,
  • "permissions": [
    ],
  • "role_assignments": [
    ],
  • "enrollment_methods": [
    ],
  • "access_requests": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "scope_type": "string",
  • "scope_uuid": "2bbb55e9-6cd6-4634-8601-f866a43d07dd",
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "priority": 9223372036854776000,
  • "is_active": true,
  • "permissions": [
    ],
  • "role_assignments": [
    ],
  • "enrollment_methods": [
    ],
  • "access_requests": [
    ],
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Retrieve

User Roles Within a Scope

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Role.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "scope_type": "string",
  • "scope_uuid": "2bbb55e9-6cd6-4634-8601-f866a43d07dd",
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "priority": 9223372036854776000,
  • "is_active": true,
  • "permissions": [
    ],
  • "role_assignments": [
    ],
  • "enrollment_methods": [
    ],
  • "access_requests": [
    ],
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Update

User Roles Within a Scope

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Role.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
required
scope_type
required
string
scope_uuid
required
string <uuid>
slug
required
string <= 50 characters ^[-a-zA-Z0-9_]+$
name
required
string <= 255 characters
description
string
text_format
string (TextFormatEnum)
Enum: "TEXT" "HTML" "MD"
  • TEXT - Plain Text
  • HTML - HTML
  • MD - Markdown
priority
required
integer <int64> [ 0 .. 9223372036854776000 ]

Low values mean less privileges. Make sure to correctly prioritize the rolls to avoid privilege escalation.

is_active
boolean (Active)
permissions
required
Array of strings
role_assignments
required
Array of strings <uuid> [ items <uuid > ]
enrollment_methods
required
Array of strings <uuid> [ items <uuid > ]
access_requests
required
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "scope_type": "string",
  • "scope_uuid": "2bbb55e9-6cd6-4634-8601-f866a43d07dd",
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "priority": 9223372036854776000,
  • "is_active": true,
  • "permissions": [
    ],
  • "role_assignments": [
    ],
  • "enrollment_methods": [
    ],
  • "access_requests": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "scope_type": "string",
  • "scope_uuid": "2bbb55e9-6cd6-4634-8601-f866a43d07dd",
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "priority": 9223372036854776000,
  • "is_active": true,
  • "permissions": [
    ],
  • "role_assignments": [
    ],
  • "enrollment_methods": [
    ],
  • "access_requests": [
    ],
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Partial Update

User Roles Within a Scope

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Role.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
scope_type
string
scope_uuid
string <uuid>
slug
string <= 50 characters ^[-a-zA-Z0-9_]+$
name
string <= 255 characters
description
string
text_format
string (TextFormatEnum)
Enum: "TEXT" "HTML" "MD"
  • TEXT - Plain Text
  • HTML - HTML
  • MD - Markdown
priority
integer <int64> [ 0 .. 9223372036854776000 ]

Low values mean less privileges. Make sure to correctly prioritize the rolls to avoid privilege escalation.

is_active
boolean (Active)
permissions
Array of strings
role_assignments
Array of strings <uuid> [ items <uuid > ]
enrollment_methods
Array of strings <uuid> [ items <uuid > ]
access_requests
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "scope_type": "string",
  • "scope_uuid": "2bbb55e9-6cd6-4634-8601-f866a43d07dd",
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "priority": 9223372036854776000,
  • "is_active": true,
  • "permissions": [
    ],
  • "role_assignments": [
    ],
  • "enrollment_methods": [
    ],
  • "access_requests": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "scope_type": "string",
  • "scope_uuid": "2bbb55e9-6cd6-4634-8601-f866a43d07dd",
  • "slug": "string",
  • "name": "string",
  • "description": "string",
  • "text_format": "TEXT",
  • "priority": 9223372036854776000,
  • "is_active": true,
  • "permissions": [
    ],
  • "role_assignments": [
    ],
  • "enrollment_methods": [
    ],
  • "access_requests": [
    ],
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_by": "string",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Delete

User Roles Within a Scope

Authorizations:
SessionAuthentication
path Parameters
id
required
string <uuid>

A UUID string identifying this Role.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Scope Types

List

Return a flat list of scope types.

Authorizations:
SessionAuthentication

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve

Return a scope type with scopes and allowed permissions.

Authorizations:
SessionAuthentication
path Parameters
id
required
string

Unique identifier for the scope (id or pk)

Responses

Response samples

Content type
application/json
{
  • "pk": 0,
  • "id": "string",
  • "label": "string",
  • "objects": [
    ],
  • "allowed_permissions": [
    ]
}

Translated Permissions

List

Permission Labels

Authorizations:
SessionAuthenticationNone
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

_page
integer

A page number within the paginated result set.

_page_size
integer

Number of results to return per page.

_search
string

A search term.

_sort
string

Which field to use when ordering the results.

app
string

App

codename
string

Code

language
string (Language Code)
model
string

Model

name
string
perm_string
string

Permission String

Responses

Response samples

Content type
application/json
{}

Retrieve

Permission Labels

Authorizations:
SessionAuthenticationNone
path Parameters
id
required
string <uuid>

A UUID string identifying this Permission: Translation.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "language": "string",
  • "parent": "string",
  • "name": "string"
}

List

Permissions

Authorizations:
SessionAuthenticationNone
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

_page
integer

A page number within the paginated result set.

_page_size
integer

Number of results to return per page.

_search
string

A search term.

_sort
string

Which field to use when ordering the results.

app
string

App

codename
string

Code

model
string

Model

perm_string
string

Permission String

Responses

Response samples

Content type
application/json
{}

Retrieve

Permissions

Authorizations:
SessionAuthenticationNone
path Parameters
id
required
integer

A unique integer value identifying this permission.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "codename": "string",
  • "perm_string": "string",
  • "perm_display_name": "string",
  • "app": "string",
  • "app_display_name": "string",
  • "model": "string",
  • "model_display_name": "string"
}

User Profiles

List

Users

Authorizations:
SessionAuthentication
query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

_page
integer

A page number within the paginated result set.

_page_size
integer

Number of results to return per page.

_search
string

A search term.

_sort
string

Which field to use when ordering the results.

description__icontains
string
email__icontains
string
first_name__icontains
string
is_staff
boolean
last_name__icontains
string
username__icontains
string

Responses

Response samples

Content type
application/json
{}

Retrieve

Users

Authorizations:
SessionAuthentication
path Parameters
username
required
string

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "username": "string",
  • "full_name": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "description": "string",
  • "picture": "http://example.com",
  • "is_staff": true,
  • "last_login": "2019-08-24T14:15:22Z",
  • "date_joined": "2019-08-24T14:15:22Z"
}

Update

Users

Authorizations:
SessionAuthentication
path Parameters
username
required
string

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
first_name
string <= 150 characters
last_name
string <= 150 characters
description
string
picture
string or null <uri> (Profile Picture)
last_login
string or null <date-time>
date_joined
string <date-time>

Responses

Request samples

Content type
{
  • "first_name": "string",
  • "last_name": "string",
  • "description": "string",
  • "picture": "http://example.com",
  • "last_login": "2019-08-24T14:15:22Z",
  • "date_joined": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "username": "string",
  • "full_name": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "description": "string",
  • "picture": "http://example.com",
  • "is_staff": true,
  • "last_login": "2019-08-24T14:15:22Z",
  • "date_joined": "2019-08-24T14:15:22Z"
}

Partial Update

Users

Authorizations:
SessionAuthentication
path Parameters
username
required
string

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Request Body schema:
first_name
string <= 150 characters
last_name
string <= 150 characters
description
string
picture
string or null <uri> (Profile Picture)
last_login
string or null <date-time>
date_joined
string <date-time>

Responses

Request samples

Content type
{
  • "first_name": "string",
  • "last_name": "string",
  • "description": "string",
  • "picture": "http://example.com",
  • "last_login": "2019-08-24T14:15:22Z",
  • "date_joined": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "username": "string",
  • "full_name": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "description": "string",
  • "picture": "http://example.com",
  • "is_staff": true,
  • "last_login": "2019-08-24T14:15:22Z",
  • "date_joined": "2019-08-24T14:15:22Z"
}

Delete

Users

Authorizations:
SessionAuthentication
path Parameters
username
required
string

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

query Parameters
_expand
string

Relationships to be expanded in the response

_fields
string

Fields to be included in the response

_omit
string

Fields to be removed from the response

Responses