LogoLogo
✉️ Contact💬 Forum
Guides de data.gouv.fr
Guides de data.gouv.fr
  • Bienvenue
  • ❓Foire aux questions
  • Documentation de data.gouv.fr
    • Créer un compte utilisateur et rejoindre une organisation
    • Organisation
      • Créer une organisation
      • Suivre l'activité et modifier son organisation
      • Gérer les membres de son organisation
      • Certifier une organisation
      • Supprimer une organisation
    • Jeux de données
      • Publier un jeu de données
        • Publier une Base Adresse Locale
      • Gérer un jeu de données
      • Explorer un jeu de donnée
      • Télécharger le catalogue de données de data.gouv.fr
      • Accéder au catalogue via SPARQL
    • API
      • Publier une API
      • Gérer une API
      • Outils pour les administrations
        • Doctrine des API
        • Accompagnement humain
        • Datapass : Outil d'habilitations
        • Bouquets API Entreprise et API Particulier
    • Réutilisations
      • Publier une réutilisation
      • Gérer une réutilisation
    • Statistiques
    • Ressource communautaire
    • Moissonnage
      • Comprendre les limites du moissonnage
      • Les différents types de moissonneurs
      • Mettre en place un moissonneur
      • Analyser le rapport de moissonnage
      • Moissonnage des plateformes géographiques
    • API de data.gouv.fr
      • Prise en main de l'API
      • Tutoriel d'utilisation
      • Gérer un jeu de données par l'API
      • Référence
        • site
        • datasets
        • reuses
        • discussions
        • organizations
        • spatial
        • users
        • me
        • contacts
        • workers
        • tags
        • topics
        • posts
        • transfer
        • notifications
        • avatars
        • harvest
  • Guides open data
    • Guide juridique
      • Producteurs de données
        • Comprendre la notion d'open data
        • Qui est concerné ?
        • Quelles sont les obligations ?
      • Réutilisateurs de données
        • Respecter les conditions de réutilisation
      • Chronologie de l'open data
    • Guide qualité
      • Evaluer le niveau de qualité d'un jeu de données
      • Préparer un jeu de données de qualité
        • Extraire un jeu de données d'un système d'information
        • Structurer un jeu de données
          • Structurer une Base Adresse Locale
        • Lier des données à un référentiel
      • Documenter des données
        • Bien documenter un jeu de données
        • Diffuser la documentation d'un jeu de données
      • Améliorer la qualité d'un jeu de données en continu
        • Améliorer le score de qualité des métadonnées
        • Connaître et suivre les usages d'un jeu de données
        • Mettre en place une stratégie organisationnelle
      • Maîtriser les schémas de données
        • Comprendre les bénéfices d'utiliser un schéma de données
        • Créer un schéma de données
          • Etape 1 : Phase d'investigation
          • Etape 2 : Phase de concertation
          • Etape 3 : Phase de construction
          • Etape 4 : Phase de promotion et de maintien
          • Focus : Construire un schéma TableSchema
        • Intégrer un schéma de données à schema.data.gouv.fr
        • Produire des données en conformité avec un schéma
        • Indiquer et vérifier qu'une ressource respecte un schéma de données
  • Guides sur l'utilisation des données
    • Introduction à l'open data
      • Comprendre la notion d'open data
      • Comprendre l'écosystème de l'open data
      • Comprendre les conditions d'utilisation des données en open data
      • Découvrir et utiliser data.gouv.fr
    • Guide traitement et analyse de données
      • Trouver des données
      • Prendre connaissance et évaluer la qualité de données
      • Explorer des données
      • Récupérer des données
      • Manipuler des données
        • Ouvrir des données
        • Filtrer des données
        • Nettoyer des données
        • Croiser des données
        • Géocoder des adresses
      • Analyser des données
        • Analyser des données avec le tableur LibreOffice Calc
        • Analyser des données avec Python
        • Analyser des données avec R
      • Visualiser des données
      • Cartographier des données
      • Réaliser des projets utiles et s'inspirer
      • Poser des questions aux producteurs de données
      • Valoriser ses travaux
      • Autres ressources pédagogiques
    • Guide API géographiques
      • Utiliser l'API Adresse
        • Rappel sur les données adresses
        • Géocoder des adresses - théorie
        • Géocoder des adresses - cas pratiques
        • FAQ Adresse
      • Utiliser l'API Découpage administratif
      • Utiliser les tuiles vectorielles
    • Guide données du cadastre
      • Comprendre les données du cadastre et leurs usages
      • Manipuler les données du cadastre
      • Foire aux questions sur le cadastre
    • Guide données météorologiques
    • Guide API "Adresse" de l'IGN
  • Autres ressources utiles
    • Lexique de l'open data
    • Données de la commande publique
      • Publier les données essentielles d’attribution des marchés
      • Déclaration d’un profil d’acheteur
    • Données de forte valeur : métadonnées obligatoires et modalités de rapportage
    • Ressources OpenDataFrance
    • Documentation de transport.data.gouv.fr
    • Les algorithmes publics : pourquoi et comment les expliquer ?
      • Les algorithmes publics : enjeux et obligations
      • Fiche pratique : l'obligation de mention explicite
      • Fiche pratique : l'inventaire des principaux traitements algorithmiques
      • Liste de ressources
    • Codes sources du secteur public : lesquels ouvrir, pourquoi et comment ?
      • Ce document n'est pas...
      • Cadre juridique
    • Catalogage de données - GRIST
    • 📒Guide du participant au Hackathon Météo
      • Ressources du hackathon
        • Données
        • Prise en main des données
        • Outils
        • Programme
        • Informations pratiques
        • Contacts
      • Avant le hackathon
      • Pendant le hackathon : règles et bonnes pratiques
        • Choix du défi
        • Constitution des équipes
        • Sollicitation des mentors
        • Documentation des réalisations
        • Rendu intermédiaire
        • Soumission du projet
        • Evaluation des projets
      • Après le hackathon
        • Evaluation du hackathon
        • Valorisation de votre projet
Propulsé par GitBook
Sur cette page

Cet article vous a-t-il été utile ?

Modifier sur GitHub
Exporter en PDF
  1. Documentation de data.gouv.fr
  2. API de data.gouv.fr
  3. Référence

users

User related operations

PrécédentspatialSuivantme

Dernière mise à jour il y a 1 an

Cet article vous a-t-il été utile ?

List all possible user roles

get
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses
200
Success
application/json
get
GET /api/1/users/roles/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200

Success

[
  {
    "name": "text"
  }
]

Suggest users

get
Paramètres de requête
qstringRequis

The string to autocomplete/suggest

sizestringOptionnel

The amount of suggestion to fetch (between 1 and 20)

Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses
200
Success
application/json
get
GET /api/1/users/suggest/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200

Success

[
  {
    "avatar_url": "text",
    "email": {},
    "first_name": "text",
    "id": "text",
    "last_name": "text",
    "slug": "text"
  }
]

List all followers for a given object

get
Paramètres de chemin
idanyRequis
Paramètres de requête
pageintegerOptionnel

The page to fetch

page_sizeintegerOptionnel

The page size to fetch

userstringOptionnel

Filter follower by user, it allows to check if a user is following the object

Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses
200
Success
application/json
get
GET /api/1/users/{id}/followers/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200

Success

{
  "data": [
    {
      "follower": {
        "class": "text",
        "id": "text",
        "avatar": "text",
        "avatar_thumbnail": "text",
        "first_name": "text",
        "last_name": "text",
        "page": "text",
        "slug": "text",
        "uri": "text"
      },
      "id": "text",
      "since": "2025-05-29T01:50:17.216Z"
    }
  ],
  "next_page": "text",
  "page": 1,
  "page_size": 1,
  "previous_page": "text",
  "total": 1
}

Follow a user given its ID

post
Paramètres de chemin
idanyRequis
Réponses
403
When trying to follow yourself
post
POST /api/1/users/{id}/followers/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
403

When trying to follow yourself

Aucun contenu

Unfollow an object given its ID

delete

Returns the number of followers left after the operation

Paramètres de chemin
idanyRequis
Réponses
200
Success
delete
DELETE /api/1/users/{id}/followers/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200

Success

Aucun contenu

Get a user given its identifier

get
Paramètres de chemin
useranyRequis
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses
200
Success
application/json
404
User not found
410
User is not active or has been deleted
get
GET /api/1/users/{user}/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
{
  "about": "text",
  "active": true,
  "avatar": "text",
  "avatar_thumbnail": "text",
  "email": {},
  "first_name": "text",
  "id": "text",
  "last_login_at": {},
  "last_name": "text",
  "metrics": {},
  "organizations": [
    {
      "class": "text",
      "id": "text",
      "acronym": "text",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "logo": "text",
      "logo_thumbnail": "text",
      "name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    }
  ],
  "page": "text",
  "roles": [
    "text"
  ],
  "since": "2025-05-29T01:50:17.216Z",
  "slug": "text",
  "uri": "text",
  "website": "text"
}

Delete a user given its identifier

delete
Paramètres de chemin
useranyRequis
Paramètres de requête
no_mailbooleanOptionnel

Do not send a mail to notify the user of the deletion

delete_commentsbooleanOptionnel

Delete comments posted by the user upon user deletion

Réponses
204
Object deleted
403
When trying to delete yourself
404
User not found
410
User is not active or has been deleted
delete
DELETE /api/1/users/{user}/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*

Aucun contenu

  • GETList all users
  • POSTCreate a new object
  • GETList all possible user roles
  • GETSuggest users
  • GETList all followers for a given object
  • POSTFollow a user given its ID
  • DELETEUnfollow an object given its ID
  • GETGet a user given its identifier
  • PUTUpdate a user given its identifier
  • DELETEDelete a user given its identifier

List all users

get
Paramètres de requête
qstringOptionnel

The search query

sortstring · enumOptionnel

The field (and direction) on which sorting apply

Valeurs possibles:
pageintegerOptionnel

The page to display

page_sizeintegerOptionnel

The page size

Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Réponses
200
Success
application/json
get
GET /api/1/users/ HTTP/1.1
Host: www.data.gouv.fr
Accept: */*
200

Success

{
  "data": [
    {
      "about": "text",
      "active": true,
      "avatar": "text",
      "avatar_thumbnail": "text",
      "email": {},
      "first_name": "text",
      "id": "text",
      "last_login_at": {},
      "last_name": "text",
      "metrics": {},
      "organizations": [
        {
          "class": "text",
          "id": "text",
          "acronym": "text",
          "badges": [
            {
              "kind": "text"
            }
          ],
          "logo": "text",
          "logo_thumbnail": "text",
          "name": "text",
          "page": "text",
          "slug": "text",
          "uri": "text"
        }
      ],
      "page": "text",
      "roles": [
        "text"
      ],
      "since": "2025-05-29T01:50:17.216Z",
      "slug": "text",
      "uri": "text",
      "website": "text"
    }
  ],
  "next_page": "text",
  "page": 1,
  "page_size": 1,
  "previous_page": "text",
  "total": 1
}

Create a new object

post
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Corps
aboutstring · markdownOptionnel

The user self description

activebooleanOptionnel
avatarstringOptionnel

The user avatar URL

avatar_thumbnailstringOptionnel

The user avatar thumbnail URL. This is the square (500x500) and cropped version.

emailobjectLecture seuleOptionnel

The user email

first_namestringRequis

The user first name

idstringRequis

The user identifier

last_login_atobjectLecture seuleOptionnel

The user last connection date (only present for global admins and on /me)

last_namestringRequis

The user last name

metricsobjectLecture seuleOptionnel

The user metrics

pagestringLecture seuleOptionnel

The user profile page URL

rolesstring[]Optionnel

Site wide user roles

sincestring · date-timeRequis

The registeration date

slugstringRequis

The user permalink string

uristringRequis

The user API URI

websitestringOptionnel

The user website

Réponses
201
Success
application/json
400
Validation error
post
POST /api/1/users/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 335

{
  "about": "text",
  "active": true,
  "avatar": "text",
  "avatar_thumbnail": "text",
  "first_name": "text",
  "id": "text",
  "last_name": "text",
  "organizations": [
    {
      "class": "text",
      "id": "text",
      "acronym": "text",
      "logo": "text",
      "logo_thumbnail": "text",
      "slug": "text"
    }
  ],
  "roles": [
    "text"
  ],
  "since": "2025-05-29T01:50:17.216Z",
  "slug": "text",
  "uri": "text",
  "website": "text"
}
{
  "about": "text",
  "active": true,
  "avatar": "text",
  "avatar_thumbnail": "text",
  "email": {},
  "first_name": "text",
  "id": "text",
  "last_login_at": {},
  "last_name": "text",
  "metrics": {},
  "organizations": [
    {
      "class": "text",
      "id": "text",
      "acronym": "text",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "logo": "text",
      "logo_thumbnail": "text",
      "name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    }
  ],
  "page": "text",
  "roles": [
    "text"
  ],
  "since": "2025-05-29T01:50:17.216Z",
  "slug": "text",
  "uri": "text",
  "website": "text"
}

Update a user given its identifier

put
Paramètres de chemin
useranyRequis
Paramètres d'en-tête
X-Fieldsstring · maskOptionnel

An optional fields mask

Corps
aboutstring · markdownOptionnel

The user self description

activebooleanOptionnel
avatarstringOptionnel

The user avatar URL

avatar_thumbnailstringOptionnel

The user avatar thumbnail URL. This is the square (500x500) and cropped version.

emailobjectLecture seuleOptionnel

The user email

first_namestringRequis

The user first name

idstringRequis

The user identifier

last_login_atobjectLecture seuleOptionnel

The user last connection date (only present for global admins and on /me)

last_namestringRequis

The user last name

metricsobjectLecture seuleOptionnel

The user metrics

pagestringLecture seuleOptionnel

The user profile page URL

rolesstring[]Optionnel

Site wide user roles

sincestring · date-timeRequis

The registeration date

slugstringRequis

The user permalink string

uristringRequis

The user API URI

websitestringOptionnel

The user website

Réponses
200
Success
application/json
400
Validation error
404
User not found
410
User is not active or has been deleted
put
PUT /api/1/users/{user}/ HTTP/1.1
Host: www.data.gouv.fr
Content-Type: application/json
Accept: */*
Content-Length: 335

{
  "about": "text",
  "active": true,
  "avatar": "text",
  "avatar_thumbnail": "text",
  "first_name": "text",
  "id": "text",
  "last_name": "text",
  "organizations": [
    {
      "class": "text",
      "id": "text",
      "acronym": "text",
      "logo": "text",
      "logo_thumbnail": "text",
      "slug": "text"
    }
  ],
  "roles": [
    "text"
  ],
  "since": "2025-05-29T01:50:17.216Z",
  "slug": "text",
  "uri": "text",
  "website": "text"
}
{
  "about": "text",
  "active": true,
  "avatar": "text",
  "avatar_thumbnail": "text",
  "email": {},
  "first_name": "text",
  "id": "text",
  "last_login_at": {},
  "last_name": "text",
  "metrics": {},
  "organizations": [
    {
      "class": "text",
      "id": "text",
      "acronym": "text",
      "badges": [
        {
          "kind": "text"
        }
      ],
      "logo": "text",
      "logo_thumbnail": "text",
      "name": "text",
      "page": "text",
      "slug": "text",
      "uri": "text"
    }
  ],
  "page": "text",
  "roles": [
    "text"
  ],
  "since": "2025-05-29T01:50:17.216Z",
  "slug": "text",
  "uri": "text",
  "website": "text"
}