You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/content/en/open_source/api-v2-docs.md
+3-6Lines changed: 3 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,13 +5,10 @@ draft: false
5
5
weight: 2
6
6
---
7
7
8
-
9
-
10
-
11
8
DefectDojo\'s API is created using [Django Rest
12
9
Framework](http://www.django-rest-framework.org/). The documentation of
13
10
each endpoint is available within each DefectDojo installation at
14
-
[`/api/v2/doc/`](https://demo.defectdojo.org/api/v2/) and can be accessed by choosing the API v2
11
+
[`/api/v2/oa3/swagger-ui`](https://demo.defectdojo.org/api/v2/oa3/swagger-ui/)) and can be accessed by choosing the API v2
15
12
Docs link on the user drop down menu in the header.
16
13
17
14

@@ -45,7 +42,7 @@ For example: :
45
42
46
43
### Alternative authentication method
47
44
48
-
If you use [an alternative authentication method](../social-authentication/) for users, you may want to disable DefectDojo API tokens because it could bypass your authentication concept. \
45
+
If you use [an alternative authentication method](../archived_docs/integrations/social-authentication/) for users, you may want to disable DefectDojo API tokens because it could bypass your authentication concept. \
49
46
Using of DefectDojo API tokens can be disabled by specifying the environment variable `DD_API_TOKENS_ENABLED` to `False`.
50
47
Or only `api/v2/api-token-auth/` endpoint can be disabled by setting `DD_API_TOKEN_AUTH_ENDPOINT_ENABLED` to `False`.
51
48
@@ -128,7 +125,7 @@ The json object result is: :
128
125
{{< /highlight >}}
129
126
130
127
See [Django Rest Framework\'s documentation on interacting with an
131
-
API](http://www.django-rest-framework.org/topics/api-clients/) for
Find the settings file (hint: `/dojo/settings/settings.dist.py`) and add the following:
52
+
Find the settings file (hint: check in `/dojo/settings/settings.py` for instructions for how to use `/dojo/settings/local_settings.py`, if the file does not already exist) and add the following:
53
53
54
54
At the top of the file:
55
55
```python
@@ -116,7 +116,7 @@ Read the docs for Django Authentication with LDAP here: https://django-auth-ldap
116
116
117
117
#### docker-compose.yml
118
118
119
-
In order to pass the variables to the settings.dist.py file via docker, it's a good idea to add these to the docker compose file.
119
+
In order to pass the variables to the local_settings.py file via docker, it's a good idea to add these to the docker compose file.
120
120
121
121
You can do this by adding the following variables to the environment section for the uwsgi image:
0 commit comments