Points de terminaison d'API REST pour Utilisateurs
Liste paginée des adresses mail de l'utilisateur connecté
Liste toutes les adresses mail de l'utilisateur connecté, y compris les adresses non publiquement accessibles.
Cet endpoint nécessite l'en-tête Metarisc-Org-Id pour identifier l'organisation faisant l'appel. Le résultat de l'appel sera donc spécifique à cette organisation.
Paramètres supplémentaires
page integer
Le numéro de la page de résultats demandé.
format : int32 ≥=1 ≤=999999 default: 1
per_page integer
Limite le nombre d'objets retournés par une page. La limite est comprise entre 1 et 100, la valeur par défaut étant de 10.
format : int32 ≥=1 ≤=100 default: 10
Réponses
200 OK
Retourne un dictionnaire avec une propriété data contenant un tableau d'Objet Email (en respectant les limites de pagination). Chaque entrée du tableau constitue un Objet Email distinct. Si aucun élément n'est disponible, le tableau résultant sera vide.
GET /utilisateurs/@moi/emails
data array of object required
Tableau d'objets contenu dans la page.
100 max items
email string required
Adresse email de l'utilisateur.
format : email 256 max length
is_primary boolean required
Une adresse email "primary" est utilisée pour les notifications, la gestion du compte et les communications.
is_publicly_visible boolean required
Détermine si l'adresse email peut être publiée publiquement.
is_verified boolean required
Détermine si l'adresse email est vérifiée.
meta object required
Métadonnées de la pagination.
pagination object required
Ensemble d'informations liées à une réponse paginée.
total integer required
Nombre total d'objets.
format : int32 ≥=0 ≤=999999
count integer required
Nombre d'objets contenu dans la page courante.
format : int32 ≥=0 ≤=999999
per_page integer required
Nombre d'objets pouvant être retournés par une page
format : int32 ≥=1 ≤=100
current_page integer required
Numéro de la page courante.
format : int32 ≥=1 ≤=999999
total_pages integer required
Nombres de pages disponibles.
format : int32 ≥=1 ≤=999999
Utilisateur connecté
L'utilisateur connecté retourné par ce point de terminaison utilise le token d'accès généré par le service OpenID Connect afin de le lier à une identité connue de Metarisc. Si l'utilisateur est inconnu une erreur est retournée.
Cet endpoint nécessite l'en-tête Metarisc-Org-Id pour identifier l'organisation faisant l'appel. Le résultat de l'appel sera donc spécifique à cette organisation.
Réponses
200 OK
Retourne un Objet Utilisateur contenant les données demandées.
GET /utilisateurs/@moi
id string required
Identifiant unique de l'utilisateur.
256 max length
first_name string required nullable
Prénom de l'utilisateur.
256 max length
last_name string required nullable
Nom de l'utilisateur.
256 max length
created_at string required
Date à laquelle l'utilisateur a été créé.
format : date-time 20 min length 50 max length
updated_at string required nullable
Date à laquelle l'utilisateur a été mis à jour.
format : date-time 20 min length 50 max length
timezone string required
Identifiant 'tz database' du Fuseau horaire de l'utilisateur. Voir : https://www.iana.org/time-zones Liste des fuseaux horaires : https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
256 max length
is_active boolean required
État d'activation du compte utilisateur.
is_verified boolean required
État de vérification du compte utilisateur.
fonction string required nullable
Fonction de l'utilisateur.
256 max length
avatar_url string required nullable
Lien URL vers l'avatar de l'utilisateur.
format : uri 512 max length
Mise à jour de l'utilisateur connecté
Mise à jour de l'utilisateur connecté.
Cet endpoint nécessite l'en-tête Metarisc-Org-Id pour identifier l'organisation faisant l'appel. Le résultat de l'appel sera donc spécifique à cette organisation.
Paramètres du corps de la requête
avatar_url string nullable
Lien URL vers l'avatar de l'utilisateur.
format : uri 512 max length
Réponses
200 OK
Retourne un Objet Utilisateur contenant les données demandées.
PATCH /utilisateurs/@moi
id string required
Identifiant unique de l'utilisateur.
256 max length
first_name string required nullable
Prénom de l'utilisateur.
256 max length
last_name string required nullable
Nom de l'utilisateur.
256 max length
created_at string required
Date à laquelle l'utilisateur a été créé.
format : date-time 20 min length 50 max length
updated_at string required nullable
Date à laquelle l'utilisateur a été mis à jour.
format : date-time 20 min length 50 max length
timezone string required
Identifiant 'tz database' du Fuseau horaire de l'utilisateur. Voir : https://www.iana.org/time-zones Liste des fuseaux horaires : https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
256 max length
is_active boolean required
État d'activation du compte utilisateur.
is_verified boolean required
État de vérification du compte utilisateur.
fonction string required nullable
Fonction de l'utilisateur.
256 max length
avatar_url string required nullable
Lien URL vers l'avatar de l'utilisateur.
format : uri 512 max length
Liste paginée des utilisateurs
Liste des utilisateurs.
Cet endpoint nécessite l'en-tête Metarisc-Org-Id pour identifier l'organisation faisant l'appel. Le résultat de l'appel sera donc spécifique à cette organisation.
Paramètres
email string
Filtre sur les emails de l'utilisateur.
format : email 256 max length
last_name string
Filtre sur le nom de l'utilisateur.
256 max length
Paramètres supplémentaires
page integer
Le numéro de la page de résultats demandé.
format : int32 ≥=1 ≤=999999 default: 1
per_page integer
Limite le nombre d'objets retournés par une page. La limite est comprise entre 1 et 100, la valeur par défaut étant de 10.
format : int32 ≥=1 ≤=100 default: 10
Réponses
200 OK
Retourne un dictionnaire avec une propriété data contenant un tableau d'Objet Utilisateur (en respectant les limites de pagination). Chaque entrée du tableau constitue un Objet Utilisateur distinct. Si aucun élément n'est disponible, le tableau résultant sera vide.
GET /utilisateurs
data array of object required
Tableau d'objets contenu dans la page.
100 max items
id string required
Identifiant unique de l'utilisateur.
256 max length
first_name string required nullable
Prénom de l'utilisateur.
256 max length
last_name string required nullable
Nom de l'utilisateur.
256 max length
created_at string required
Date à laquelle l'utilisateur a été créé.
format : date-time 20 min length 50 max length
updated_at string required nullable
Date à laquelle l'utilisateur a été mis à jour.
format : date-time 20 min length 50 max length
timezone string required
Identifiant 'tz database' du Fuseau horaire de l'utilisateur. Voir : https://www.iana.org/time-zones Liste des fuseaux horaires : https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
256 max length
is_active boolean required
État d'activation du compte utilisateur.
is_verified boolean required
État de vérification du compte utilisateur.
fonction string required nullable
Fonction de l'utilisateur.
256 max length
avatar_url string required nullable
Lien URL vers l'avatar de l'utilisateur.
format : uri 512 max length
meta object required
Métadonnées de la pagination.
pagination object required
Ensemble d'informations liées à une réponse paginée.
total integer required
Nombre total d'objets.
format : int32 ≥=0 ≤=999999
count integer required
Nombre d'objets contenu dans la page courante.
format : int32 ≥=0 ≤=999999
per_page integer required
Nombre d'objets pouvant être retournés par une page
format : int32 ≥=1 ≤=100
current_page integer required
Numéro de la page courante.
format : int32 ≥=1 ≤=999999
total_pages integer required
Nombres de pages disponibles.
format : int32 ≥=1 ≤=999999
Liste paginée des adresses mail d'un utilisateur
Retourne une liste des adresses mail publiques d'un utilisateur.
Cet endpoint nécessite l'en-tête Metarisc-Org-Id pour identifier l'organisation faisant l'appel. Le résultat de l'appel sera donc spécifique à cette organisation.
Paramètres supplémentaires
page integer
Le numéro de la page de résultats demandé.
format : int32 ≥=1 ≤=999999 default: 1
per_page integer
Limite le nombre d'objets retournés par une page. La limite est comprise entre 1 et 100, la valeur par défaut étant de 10.
format : int32 ≥=1 ≤=100 default: 10
Réponses
200 OK
Retourne un dictionnaire avec une propriété data contenant un tableau d'Objet Email (en respectant les limites de pagination). Chaque entrée du tableau constitue un Objet Email distinct. Si aucun élément n'est disponible, le tableau résultant sera vide.
GET /utilisateurs/{utilisateur_id}/emails
data array of object required
Tableau d'objets contenu dans la page.
100 max items
email string required
Adresse email de l'utilisateur.
format : email 256 max length
is_primary boolean required
Une adresse email "primary" est utilisée pour les notifications, la gestion du compte et les communications.
is_publicly_visible boolean required
Détermine si l'adresse email peut être publiée publiquement.
is_verified boolean required
Détermine si l'adresse email est vérifiée.
meta object required
Métadonnées de la pagination.
pagination object required
Ensemble d'informations liées à une réponse paginée.
total integer required
Nombre total d'objets.
format : int32 ≥=0 ≤=999999
count integer required
Nombre d'objets contenu dans la page courante.
format : int32 ≥=0 ≤=999999
per_page integer required
Nombre d'objets pouvant être retournés par une page
format : int32 ≥=1 ≤=100
current_page integer required
Numéro de la page courante.
format : int32 ≥=1 ≤=999999
total_pages integer required
Nombres de pages disponibles.
format : int32 ≥=1 ≤=999999
Détails d'un utilisateur
Retourne un utilisateur Metarisc.
Cet endpoint nécessite l'en-tête Metarisc-Org-Id pour identifier l'organisation faisant l'appel. Le résultat de l'appel sera donc spécifique à cette organisation.
Réponses
200 OK
Retourne un Objet Utilisateur contenant les données demandées.
GET /utilisateurs/{utilisateur_id}
id string required
Identifiant unique de l'utilisateur.
256 max length
first_name string required nullable
Prénom de l'utilisateur.
256 max length
last_name string required nullable
Nom de l'utilisateur.
256 max length
created_at string required
Date à laquelle l'utilisateur a été créé.
format : date-time 20 min length 50 max length
updated_at string required nullable
Date à laquelle l'utilisateur a été mis à jour.
format : date-time 20 min length 50 max length
timezone string required
Identifiant 'tz database' du Fuseau horaire de l'utilisateur. Voir : https://www.iana.org/time-zones Liste des fuseaux horaires : https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
256 max length
is_active boolean required
État d'activation du compte utilisateur.
is_verified boolean required
État de vérification du compte utilisateur.
fonction string required nullable
Fonction de l'utilisateur.
256 max length
avatar_url string required nullable
Lien URL vers l'avatar de l'utilisateur.
format : uri 512 max length
Liste paginée des organisations d'un utilisateur
Retourne une liste d'organisations dont l'utilisateur est membre.
Cet endpoint nécessite l'en-tête Metarisc-Org-Id pour identifier l'organisation faisant l'appel. Le résultat de l'appel sera donc spécifique à cette organisation.
Paramètres supplémentaires
page integer
Le numéro de la page de résultats demandé.
format : int32 ≥=1 ≤=999999 default: 1
per_page integer
Limite le nombre d'objets retournés par une page. La limite est comprise entre 1 et 100, la valeur par défaut étant de 10.
format : int32 ≥=1 ≤=100 default: 10
Réponses
200 OK
Retourne un dictionnaire avec une propriété data contenant un tableau d'Objet Organisation Membre (en respectant les limites de pagination). Chaque entrée du tableau constitue un Objet Organisation Membre distinct. Si aucun élément n'est disponible, le tableau résultant sera vide.
GET /utilisateurs/{utilisateur_id}/organisations
data array of object required
Tableau d'objets contenu dans la page.
100 max items
organisation object required
Organisation liée au membre.
id string required
Identifiant unique de l'objet.
format : uuid 36 fixed length
nom string required
Nom de l'organisation.
256 max length
logo_url string required nullable
Lien URL vers le logo représentant l'organisation.
format : uri 512 max length
type string required
Type de l'organisation.
| Valeurs possibles |
|---|
sisOrganisation de type Service d'Incendie et de Secours. |
utilisateur object required
Informations de l'utilisateur lié.
id string required
Identifiant unique de l'utilisateur.
256 max length
first_name string required nullable
Prénom de l'utilisateur.
256 max length
last_name string required nullable
Nom de l'utilisateur.
256 max length
created_at string required
Date à laquelle l'utilisateur a été créé.
format : date-time 20 min length 50 max length
updated_at string required nullable
Date à laquelle l'utilisateur a été mis à jour.
format : date-time 20 min length 50 max length
timezone string required
Identifiant 'tz database' du Fuseau horaire de l'utilisateur. Voir : https://www.iana.org/time-zones Liste des fuseaux horaires : https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
256 max length
is_active boolean required
État d'activation du compte utilisateur.
is_verified boolean required
État de vérification du compte utilisateur.
fonction string required nullable
Fonction de l'utilisateur.
256 max length
avatar_url string required nullable
Lien URL vers l'avatar de l'utilisateur.
format : uri 512 max length
date_integration string
Date à laquelle l'utilisateur à rejoint l'organisation en tant que membre.
format : date-time 20 min length 50 max length
role string required
Rôle du membre au sein de l'organisation.
256 max length
| Valeurs possibles |
|---|
membreMembre de l'organisation. |
inviteInvité de l'organisation. |
invitation_en_coursInvitation en cours de l'utilisateur à rejoindre l'organisation. |
meta object required
Métadonnées de la pagination.
pagination object required
Ensemble d'informations liées à une réponse paginée.
total integer required
Nombre total d'objets.
format : int32 ≥=0 ≤=999999
count integer required
Nombre d'objets contenu dans la page courante.
format : int32 ≥=0 ≤=999999
per_page integer required
Nombre d'objets pouvant être retournés par une page
format : int32 ≥=1 ≤=100
current_page integer required
Numéro de la page courante.
format : int32 ≥=1 ≤=999999
total_pages integer required
Nombres de pages disponibles.
format : int32 ≥=1 ≤=999999
Liste complète des permissions d'un utilisateur
Retourne l'ensemble des permissions d'un utilisateur Metarisc.
Cet endpoint nécessite l'en-tête Metarisc-Org-Id pour identifier l'organisation faisant l'appel. Le résultat de l'appel sera donc spécifique à cette organisation.
Réponses
200 OK
Retourne un tableau d'Objet Permission Globale. Chaque entrée du tableau constitue un Objet Permission Globale distinct. Si aucun élément n'est disponible, le tableau résultant sera vide.
GET /utilisateurs/{utilisateur_id}/permissions
data array of object required
Liste d'objets.
100 max items
name string required
Nom de la permission.
| Valeurs possibles |
|---|
deci:accessAccès aux fonctionnalités DECI. |
erp:accessAccès aux fonctionnalités ERP. |
sirene:accessAccès aux fonctionnalités SIRENE. |
dossier:createCréation de dossiers ERP. |
erp:createCréation d'ERP. |
commission:accessAccès aux commissions de sécurité. |