Exporting users and groups

GET https://{{host}}/users/api/athentose_user/export_csv/?active-team=true&include-fields=identification_number

This URL returns the users from a team or from the whole service.

To be able to use this service, the user must be:

  • Part of the team admin group

  • The user must be is_onlyusermanager and is_service

Team admin users will be able to download the users on their teams, and users with the flags is_onlyusermanager and is_service will be able to access users from all teams.

Params

active-team

If its true, the endpoint will only return users from active team of the user.

include-fields

It is possible to add extra fields to export. At the momento only identification_number is available.

Response

The response is a CSV file with header

username;firstname;lastname;email;lastlogin;groups;teams;isactive;identification_number

Request Params

KeyDatatypeRequiredDescription
active-teamboolean
include-fieldsstring