Admins

Admin users

Endpoint: /admin/users

Allowed methods: GET/POST

GET

It returns a JSON object with the following information:

  • form: A form for searching for users.
  • found: A list of found users according to a search.
  • template: Jinja2 template.
  • users: List of admin users.

Example output

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
{
  "form": {
    "csrf": "token",
    "errors": {},
    "user": null
  },
  "found": [],
  "template": "/admin/users.html",
  "title": "Manage Admin Users",
  "users": [
    {
      "admin": true,
      "api_key": "key",
      "category": null,
      "ckan_api": null,
      "confirmation_email_sent": false,
      "created": "date",
      "email_addr": "email",
      "facebook_user_id": null,
      "flags": null,
      "fullname": "John Doe",
      "google_user_id": null,
      "id": 1,
      "info": {
        "avatar": "avatar.png",
        "container": "user_1"
      },
      "locale": "en",
      "name": "johndoe",
      "newsletter_prompted": false,
      "passwd_hash": "hash",
      "privacy_mode": true,
      "pro": false,
      "subscribed": true,
      "twitter_user_id": null,
      "valid_email": true
    },
  ]
}

POST

To send a valid POST request you need to pass the csrf token in the headers. Use the following header: “X-CSRFToken”.

It returns a JSON object with the following information:

  • form: A form with the submitted search.
  • found: A list of found users according to a search.
  • template: Jinja2 template.
  • users: List of admin users.

Example output

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
{
  "form": {
    "csrf": "token",
    "errors": {},
    "user": 'janedoe',
  },
  "found": [
        {
          "admin": false,
          "api_key": "key",
          "category": null,
          "ckan_api": null,
          "confirmation_email_sent": false,
          "created": "date",
          "email_addr": "email",
          "facebook_user_id": null,
          "flags": null,
          "fullname": "janedoe",
          "google_user_id": null,
          "id": 80,
          "info": {},
          "locale": "en",
          "name": "janedoe",
          "newsletter_prompted": false,
          "passwd_hash": "hash",
          "privacy_mode": true,
          "pro": false,
          "subscribed": true,
          "twitter_user_id": null,
          "valid_email": true
        },
  ],
  "template": "/admin/users.html",
  "title": "Manage Admin Users",
  "users": [
    {
      "admin": true,
      "api_key": "key",
      "category": null,
      "ckan_api": null,
      "confirmation_email_sent": false,
      "created": "date",
      "email_addr": "email",
      "facebook_user_id": null,
      "flags": null,
      "fullname": "John Doe",
      "google_user_id": null,
      "id": 1,
      "info": {
        "avatar": "avatar.png",
        "container": "user_1"
      },
      "locale": "en",
      "name": "johndoe",
      "newsletter_prompted": false,
      "passwd_hash": "hash",
      "privacy_mode": true,
      "pro": false,
      "subscribed": true,
      "twitter_user_id": null,
      "valid_email": true
    },
  ]
  }

Admin users add

Endpoint: /admin/users/add/<int:user_id>

Allowed methods: GET

GET

It adds a user to the admin group. It returns a JSON object with the following information:

  • next: ‘/admin/users’,

Example output

1
2
3
{
  "next": "/admin/users",
}

Note

You will need to use the /admin/users endpoint to get a list of users for adding deleting from the admin group.

Admin users del

Endpoint: /admin/users/del/<int:user_id>

Allowed methods: GET

GET

It removes a user from the admin group. It returns a JSON object with the following information:

  • next: ‘/admin/users’,

Example output

1
2
3
{
  "next": "/admin/users",
}

Note

You will need to use the /admin/users endpoint to get a list of users for adding deleting from the admin group.