REST Resource: users

Ressource : Utilisateur

L'API Directory vous permet de créer et de gérer les utilisateurs, les alias et les photos de profil Google des utilisateurs de votre compte. Pour en savoir plus sur les tâches courantes, consultez le Guide du développeur de comptes utilisateur et le Guide du développeur relatif aux alias d'utilisateur.

Représentation JSON 
{
  "id": string,
  "primaryEmail": string,
  "password": value,
  "hashFunction": string,
  "isAdmin": boolean,
  "isDelegatedAdmin": boolean,
  "agreedToTerms": boolean,
  "suspended": boolean,
  "changePasswordAtNextLogin": boolean,
  "ipWhitelisted": boolean,
  "name": {
    object (UserName)
  },
  "kind": string,
  "etag": string,
  "emails": value,
  "externalIds": value,
  "relations": value,
  "aliases": [
    string
  ],
  "isMailboxSetup": boolean,
  "customerId": string,
  "addresses": value,
  "organizations": value,
  "lastLoginTime": string,
  "phones": value,
  "suspensionReason": string,
  "thumbnailPhotoUrl": string,
  "languages": value,
  "posixAccounts": value,
  "creationTime": string,
  "nonEditableAliases": [
    string
  ],
  "sshPublicKeys": value,
  "notes": value,
  "websites": value,
  "locations": value,
  "includeInGlobalAddressList": boolean,
  "keywords": value,
  "deletionTime": string,
  "gender": value,
  "thumbnailPhotoEtag": string,
  "ims": value,
  "customSchemas": value,
  "isEnrolledIn2Sv": boolean,
  "isEnforcedIn2Sv": boolean,
  "archived": boolean,
  "orgUnitPath": string,
  "recoveryEmail": string,
  "recoveryPhone": string
}
Champs
id

string

Identifiant unique de l'utilisateur. Un id d'utilisateur peut être utilisé comme userKey de l'URI de la requête utilisateur.
primaryEmail

string

Adresse e-mail principale de l'utilisateur. Cette propriété est requise dans une demande de création d'un compte utilisateur. Le primaryEmail doit être unique et ne peut pas être un alias d'un autre utilisateur.
password

value (Value format)

Stocke le mot de passe du compte utilisateur. Le mot de passe de l'utilisateur est obligatoire lors de la création d'un compte utilisateur. Elle est facultative lors de la mise à jour d'un compte utilisateur et ne doit être fournie que si l'utilisateur modifie le mot de passe de son compte. La valeur du mot de passe n'est jamais renvoyée dans le corps de la réponse de l'API.

Un mot de passe peut contenir n'importe quelle combinaison de caractères ASCII et doit comporter entre 8 et 100 caractères.

Nous vous recommandons d'envoyer le paramètre password sous forme de valeur de hachage encodée en hexadécimal et de définir hashFunction en conséquence. Si hashFunction est spécifié, le mot de passe doit être une clé de hachage valide.
hashFunction

string

Stocke le format de hachage de la propriété password. Les valeurs hashFunction suivantes sont autorisées:

  • MD5 : accepte les valeurs simples encodées en hexadécimal.
  • SHA-1 : accepte les valeurs simples encodées en hexadécimal.
  • crypt : conforme à la bibliothèque de chiffrement C. Compatible avec les algorithmes de hachage DES, MD5 (préfixe de hachage $1$), SHA-256 (préfixe de hachage $5$) et SHA-512 (préfixe de hachage $6$).

Si des arrondis sont spécifiés dans le préfixe, ils ne doivent pas dépasser 10 000.
isAdmin

boolean

Uniquement en sortie. Désigne un utilisateur disposant des droits de super-administrateur. La propriété isAdmin ne peut être modifiée que dans l'opération Désigner un utilisateur comme administrateur ( méthode makeAdmin). Si la modification est effectuée dans les méthodes insert ou update de l'utilisateur, elle est ignorée par le service d'API.
isDelegatedAdmin

boolean

Uniquement en sortie. Indique si l'utilisateur est un administrateur délégué.
Les administrateurs délégués sont compatibles avec l'API, mais ne peuvent pas créer ni annuler la suppression d'utilisateurs, ni désigner des utilisateurs comme administrateurs. Ces requêtes sont ignorées par le service d'API.
Les rôles et les droits des administrateurs sont attribués via la console d'administration.
agreedToTerms

boolean

Uniquement en sortie. Cette propriété est true si l'utilisateur a effectué une connexion initiale et accepté les conditions d'utilisation.
suspended

boolean

Indique si l'utilisateur est suspendu.
changePasswordAtNextLogin

boolean

Indique si l'utilisateur est obligé de modifier son mot de passe à la prochaine connexion. Ce paramètre ne s'applique pas lorsque l'utilisateur se connecte via un fournisseur d'identité tiers.
ipWhitelisted

boolean

Si la valeur est true, l'adresse IP de l'utilisateur est soumise à une configuration d'adresse IP allowlist obsolète.
name

object (UserName)

Contient le prénom et le nom de famille de l'utilisateur, ainsi que la valeur fullName en lecture seule. Le nombre maximal de caractères dans les valeurs givenName et familyName est de 60. En outre, les valeurs de nom acceptent les caractères Unicode/UTF-8 et peuvent contenir des espaces, des lettres (a-z), des chiffres (0-9), des tirets (-), des barres obliques (/) et des points (.). Pour en savoir plus sur les règles d'utilisation des caractères, consultez le Centre d'aide destiné aux administrateurs. La taille de données maximale autorisée pour ce champ est de 1 Ko.
kind

string

Uniquement en sortie. Type de ressource d'API. Pour les ressources Utilisateurs, la valeur est admin#directory#user.
etag

string

Uniquement en sortie. ETag de la ressource.
emails

value (Value format)

Liste des adresses e-mail de l'utilisateur. La taille maximale autorisée pour les données est de 10 Ko.

Fields

emails[].address

string

Adresse e-mail de l'utilisateur. Sert également d'ID d'adresse e-mail. Il peut s'agir de l'adresse e-mail principale de l'utilisateur ou d'un alias.

emails[].customType

string

Si l'adresse e-mail type est custom, cette propriété contient la valeur personnalisée et doit être définie.

emails[].primary

boolean

Indique s'il s'agit de l'adresse e-mail principale de l'utilisateur. Une seule entrée peut être marquée comme principale.

emails[].type

string

Type de compte de messagerie. Si la valeur est custom, customType doit également être défini.

Valeurs acceptées: custom, home, other, work.
externalIds

value (Value format)

Liste des ID externes de l'utilisateur, tels qu'un ID d'employé ou de réseau. La taille de données maximale autorisée est de 2 Ko.

Fields

externalIds[].customType

string

Si l'ID externe type est custom, cette propriété contient la valeur personnalisée et doit être définie.

externalIds[].type

string

Type d'ID externe. Si la valeur est custom, customType doit également être défini.

Valeurs acceptées: account, custom, customer, login_id, network, organization.

externalIds[].value

string

Valeur de l'ID externe.
relations

value (Value format)

Liste des relations entre l'utilisateur et d'autres utilisateurs. La taille de données maximale autorisée pour ce champ est de 2 Ko. Pour en savoir plus, consultez l'article Gérer les comptes utilisateur.

Fields

relations[].customType

string

Si la relation type est custom, cette propriété contient la valeur personnalisée et doit être définie.

relations[].type

string

Type de relation. Si la valeur est custom, customType doit également être défini.

Valeurs acceptées:
  • admin_assistant
  • assistant
  • brother
  • child
  • custom
  • domestic_partner
  • dotted_line_manager
  • exec_assistant
  • father
  • friend
  • manager
  • mother
  • parent
  • partner
  • referred_by
  • relative
  • sister
  • spouse

relations[].value

string

Adresse e-mail de la personne à laquelle l'utilisateur est lié.
aliases[]

string

Uniquement en sortie. Liste des alias d'adresses e-mail de l'utilisateur.
isMailboxSetup

boolean

Uniquement en sortie. Indique si la boîte aux lettres Google de l'utilisateur a été créée. Cette propriété n'est applicable que si une licence Gmail a été attribuée à l'utilisateur.
customerId

string

Uniquement en sortie. Numéro client permettant de récupérer tous les utilisateurs du compte.
Vous pouvez utiliser l'alias my_customer pour représenter le customerId de votre compte.
En tant qu'administrateur revendeur, vous pouvez utiliser le customerId du compte client indirect. Pour obtenir un customerId, utilisez le domaine principal du compte dans le paramètre domain d'une requête users.list.
addresses

value (Value format)

Liste des adresses de l'utilisateur. La taille maximale autorisée pour les données est de 10 Ko.

Fields

addresses[].country

string

Pays.

addresses[].countryCode

string

Le code pays. Respecte la norme ISO 3166-1.

addresses[].customType

string

Si l'adresse type est custom, cette propriété contient la valeur personnalisée et doit être définie.

addresses[].extendedAddress

string

Pour les adresses étendues, telles qu'une adresse incluant une sous-région.

addresses[].formatted

string

Adresse postale complète et non structurée. Cette adresse n'est pas synchronisée avec les champs d'adresse structurés. Inclut les attributs suivants: adresse postale, zone, ville, État/province, code postal et pays/région.

addresses[].locality

string

Ville associée à l'adresse.

addresses[].poBox

string

La boîte postale, le cas échéant

addresses[].postalCode

string

Le code postal, le cas échéant.

addresses[].primary

boolean

S'il s'agit de l'adresse principale de l'utilisateur. La liste d'adresses ne peut contenir qu'une seule adresse principale.

addresses[].region

string

La province ou l'État abrégé.

addresses[].sourceIsStructured

boolean

Indique si l'adresse fournie par l'utilisateur a été mise en forme. Les adresses formatées ne sont pas acceptées pour le moment.

addresses[].streetAddress

string

Adresse postale, par exemple 1600 Amphitheatre Parkway. Les espaces blancs dans la chaîne sont ignorés. mais les sauts de ligne sont importants.

addresses[].type

string

Type d'adresse. Si la valeur est custom, customType doit également être défini.

Valeurs acceptées: custom, home, other, work.
organizations

value (Value format)

Liste des organisations auxquelles l'utilisateur appartient. La taille maximale autorisée pour les données est de 10 Ko.

Fields

organizations[].costCenter

string

Centre de coûts de l'organisation de l'utilisateur.

organizations[].customType

string

Si la valeur de type est personnalisée, cette propriété contient le type personnalisé.

organizations[].department

string

Spécifie le service au sein de l'organisation, par exemple sales ou engineering.

organizations[].description

string

Description de l'organisation.

organizations[].domain

string

Domaine auquel appartient l'organisation.

organizations[].fullTimeEquivalent

integer

Équivalent de millipercent à temps plein au sein de l'organisation (100 000 = 100%).

organizations[].location

string

L'adresse physique de l'organisation. Il n'est pas nécessaire que cette adresse soit complète.

organizations[].name

string

Nom de l'organisme.

organizations[].primary

boolean

Indique s'il s'agit de l'organisation principale de l'utilisateur. Un utilisateur ne peut avoir qu'une seule organisation principale.

organizations[].symbol

string

Symbole de chaîne de texte de l'organisation. Par exemple, le symbole textuel de Google est GOOG.

organizations[].title

string

Poste de l'utilisateur dans l'organisation. Par exemple, member ou engineer.

organizations[].type

string

Type d'organisation.

Valeurs acceptées: domain_only, school, unknown et work.
lastLoginTime

string

Uniquement en sortie. Dernière connexion de l'utilisateur au compte de l'utilisateur. La date et l'heure sont au format ISO 8601. L'heure correspond à la date complète suivie des heures, des minutes et des secondes, au format YYYY-MM-DDThh:mm:ssTZD. Exemple : 2010-04-05T17:30:04+01:00.
phones

value (Value format)

Liste des numéros de téléphone de l'utilisateur. La taille maximale autorisée pour les données est de 1 Ko.

Fields

phones[].customType

string

Si le numéro de téléphone type est custom, cette propriété contient la valeur personnalisée et doit être définie.

phones[].primary

boolean

Si true, il s'agit du numéro de téléphone principal de l'utilisateur. Un utilisateur ne peut avoir qu'un seul numéro de téléphone principal.

phones[].type

string

Type de numéro de téléphone. Si la valeur est custom, customType doit également être défini.

Valeurs acceptées: assistant, callback, car, company_main, custom, grand_central, home, home_fax, isdn, main, mobile, other, other_fax, pager, radio, telex, tty_tdd, work,
,
.work_faxwork_mobilework_pager

phones[].value

string

Numéro de téléphone intelligible. Il peut se présenter sous n'importe quel format de numéro de téléphone.
suspensionReason

string

Uniquement en sortie. la raison pour laquelle un compte utilisateur a été suspendu par l'administrateur ou par Google au moment de la suspension. La propriété n'est renvoyée que si la propriété suspended est true.
thumbnailPhotoUrl

string

Uniquement en sortie. URL de la photo de profil de l'utilisateur. L'URL peut être temporaire ou privée.
languages

value (Value format)

Liste des langues de l'utilisateur. La taille maximale autorisée pour les données est de 1 Ko.

Fields

languages[].customLanguage

string

Autre langue. S'il n'existe pas de code de langue ISO 639 correspondant, l'utilisateur peut fournir son propre nom de langue. Si cette option est définie, languageCode ne peut pas être défini.

languages[].languageCode

string

Représentation d'une langue sous forme de chaîne ISO 639. Consultez la section Codes de langue pour obtenir la liste des codes acceptés. L'API accepte les codes de langue autres que ceux qui sont acceptés, mais peut entraîner un comportement inattendu. Les valeurs non valides causent SchemaException. Si cette option est définie, customLanguage ne peut pas être défini.

languages[].preference

string

Facultatif. Si cet élément est présent, détermine si le languageCode spécifié est la langue préférée de l'utilisateur. Si customLanguage est défini, cet élément ne peut pas être défini. Les valeurs autorisées sont preferred et not_preferred.
posixAccounts

value (Value format)

Liste des informations de compte POSIX concernant l'utilisateur.

Fields

posixAccounts[].accountId

string

Identifiant de champ de compte POSIX.

posixAccounts[].gecos

string

GECOS (informations utilisateur) pour ce compte.

posixAccounts[].gid

unsigned long

L'ID du groupe par défaut.

posixAccounts[].homeDirectory

string

Chemin d'accès au répertoire d'accueil de ce compte.

posixAccounts[].operatingSystemType

string

Type de système d'exploitation pour ce compte.

Valeurs acceptées: linux, unspecified, windows.

posixAccounts[].primary

boolean

S'il s'agit du compte principal de l'utilisateur dans l'ID système.

posixAccounts[].shell

string

Chemin d'accès à l'interface système de connexion pour ce compte.

posixAccounts[].systemId

string

Identifiant système du compte auquel le nom d'utilisateur ou l'identifiant unique s'applique.

posixAccounts[].uid

unsigned long

ID utilisateur compatible avec POSIX.

posixAccounts[].username

string

Nom d'utilisateur du compte.
creationTime

string

Uniquement en sortie. Date et heure de création du compte de l'utilisateur. La date et l'heure sont au format ISO 8601. L'heure correspond à la date complète suivie des heures, des minutes et des secondes, au format YYYY-MM-DDThh:mm:ssTZD. Exemple : 2010-04-05T17:30:04+01:00.
nonEditableAliases[]

string

Uniquement en sortie. Liste des alias d'adresses e-mail non modifiables de l'utilisateur. Ils se situent généralement en dehors du domaine principal ou du sous-domaine du compte.
sshPublicKeys

value (Value format)

Liste de clés publiques SSH.

Fields

sshPublicKeys[].expirationTimeUsec

long

Délai d'expiration en microsecondes depuis l'époque.

sshPublicKeys[].fingerprint

string

Empreinte SHA-256 de la clé publique SSH. (Lecture seule)

sshPublicKeys[].key

string

Clé publique SSH.
notes

value (Value format)

Notes destinées à l'utilisateur en tant qu'objet imbriqué.

Fields

notes.contentType

string

Type de contenu de la note (texte brut ou HTML). La valeur par défaut est "Texte brut".

Valeurs acceptées: text_plain, text_html.

notes.value

string

Contenu des notes.
websites

value (Value format)

Liste des sites Web de l'utilisateur.

Fields

websites[].customType

string

Si le site Web type est custom, cette propriété contient la valeur personnalisée et doit être définie.

websites[].primary

boolean

Si la valeur est true, il s'agit du site Web principal de l'utilisateur.

websites[].type

string

Type ou objectif du site Web. Par exemple, un site Web peut être associé aux libellés home ou blog. Une entrée peut également être de type custom. Si la valeur est custom, customType doit également être défini.

Valeurs acceptées: app_install_page, blog, custom, ftp, home, home_page, other, profile, reservations, resume, work.

websites[].value

string

URL du site Web.
locations

value (Value format)

Liste des zones géographiques de l'utilisateur. La taille maximale autorisée pour les données est de 10 Ko.

Fields

locations[].area

string

Emplacement textuel. Ceci est particulièrement utile à des fins d'affichage, car il permet de décrire l'emplacement de manière concise. Par exemple, Mountain View, CA ou Near Seattle.

locations[].buildingId

string

Identifiant du bâtiment.

locations[].customType

string

Si l'emplacement type est custom, cette propriété contient la valeur personnalisée et doit être définie.

locations[].deskCode

string

Code textuel le plus spécifique pour chaque bureau.

locations[].floorName

string

Nom/Numéro de l'étage.

locations[].floorSection

string

Section de l'étage. Emplacement plus spécifique dans l'étage. Par exemple, si un étage est divisé en sections A, B et C, ce champ identifie l'une de ces valeurs.

locations[].type

string

Type d'emplacement. Si la valeur est custom, customType doit également être défini.

Valeurs acceptées: custom, default, desk.
includeInGlobalAddressList

boolean

Indique si le profil de l'utilisateur est visible dans la liste d'adresses globale de Google Workspace lorsque la fonctionnalité de partage des contacts est activée pour le domaine. Pour en savoir plus sur l'exclusion de profils utilisateur, consultez le Centre d'aide pour les administrateurs.
keywords

value (Value format)

Liste des mots clés de l'utilisateur. La taille maximale autorisée pour les données est de 1 Ko.

Fields

keywords[].customType

string

Si le mot clé type est custom, cette propriété contient la valeur personnalisée et doit être définie.

keywords[].type

string

Chaque entrée peut avoir un type qui indique le type standard de cette entrée.

Par exemple, le mot clé peut être de type occupation ou outlook. Outre le type standard, une entrée peut avoir un type custom et lui donner n'importe quel nom. Si la valeur est custom, customType doit également être défini.

Valeurs acceptées: custom, mission, occupation, outlook.

keywords[].value

string

Mot clé.
deletionTime

string

Uniquement en sortie. Heure à laquelle le compte de l'utilisateur a été supprimé. La date et l'heure sont au format ISO 8601. L'heure correspond à la date complète suivie des heures, des minutes et des secondes, au format YYYY-MM-DDThh:mm:ssTZD. Par exemple : 2010-04-05T17:30:04+01:00
gender

value (Value format)

Objet imbriqué indiquant le genre de l'utilisateur. La taille de données maximale autorisée pour ce champ est de 1 Ko.

Fields

gender.addressMeAs

string

Chaîne intelligible contenant la façon appropriée de désigner le propriétaire du profil par des humains, par exemple "il/lui/son" ou "ils/leurs".

gender.customGender

string

Nom d'un critère de sexe personnalisé.

gender.type

string

 Type de genre.

Valeurs acceptées:
  • female
  • male
  • other
  • unknown

thumbnailPhotoEtag

string

Uniquement en sortie. ETag de la photo de l'utilisateur (lecture seule)
ims

value (Value format)

Comptes de messagerie instantanée de l'utilisateur Un compte utilisateur peut avoir plusieurs propriétés ims, mais une seule de ces propriétés ims peut être le contact de messagerie instantanée principal.

Fields

ims[].customProtocol

string

Si la valeur du protocole est custom_protocol, cette propriété contient la chaîne du protocole personnalisé.

ims[].customType

string

Si le message instantané type est custom, cette propriété contient la valeur personnalisée et doit être définie.

ims[].im

string

ID de réseau de messagerie instantanée de l'utilisateur.

ims[].primary

boolean

S'il s'agit de la messagerie instantanée principale de l'utilisateur. Une seule entrée de la liste de messages instantanés peut avoir la valeur true.

ims[].protocol

string

 Un protocole de messagerie instantanée identifie le réseau de messagerie instantanée. La valeur peut être un réseau personnalisé ou le réseau standard.

Valeurs acceptées:
  • aim: protocole AOL Instant Messenger
  • custom_protocol: protocole réseau de messagerie instantanée personnalisé
  • gtalk: protocole Google Talk
  • icq: protocole ICQ
  • jabber: protocole Jabber
  • msn: protocole MSN Messenger
  • net_meeting: protocole Net Meeting
  • qq: protocole QQ
  • skype: protocole Skype
  • yahoo: protocole Yahoo Messenger

ims[].type

string

Type de compte de messagerie instantanée. Si la valeur est custom, customType doit également être défini.

Valeurs acceptées: custom, home, other, work.
customSchemas

value (Value format)

Champs personnalisés de l'utilisateur. La clé est une schemaName et ses valeurs sont 'fieldName': 'field_value'.

  • customSchemas.(key) est un objet imbriqué.
  • customSchemas.(key).(key) peut être n'importe quelle valeur.
isEnrolledIn2Sv

boolean

Uniquement en sortie. est inscrit à la validation en deux étapes (lecture seule) ;
isEnforcedIn2Sv

boolean

Uniquement en sortie. Validation en deux étapes appliquée (lecture seule)
archived

boolean

Indique si l'utilisateur est archivé.
orgUnitPath

string

Chemin d'accès complet à l'organisation parente associée à l'utilisateur. Si l'organisation parente est le niveau supérieur, elle est représentée par une barre oblique (/).
recoveryEmail

string

Adresse e-mail de récupération de l'utilisateur.
recoveryPhone

string

Numéro de téléphone de récupération de l'utilisateur. Le numéro de téléphone doit être au format E.164 et commencer par le signe plus (+). Exemple: +16506661212.

UserName

Représentation JSON 
{
  "fullName": string,
  "familyName": string,
  "givenName": string,
  "displayName": string
}
Champs
fullName

string

Nom complet de l'utilisateur formé en concaténant les valeurs de prénom et de nom.
familyName

string

Nom de l'utilisateur. Obligatoire lors de la création d'un compte utilisateur.
givenName

string

Prénom de l'utilisateur. Obligatoire lors de la création d'un compte utilisateur.
displayName

string

Nom à afficher de l'utilisateur Limite: 256 caractères.

Méthodes

delete

 Supprime un utilisateur.

get

 Récupère un utilisateur.

insert

 Crée un utilisateur.

list

 Récupère une liste paginée des utilisateurs supprimés ou de tous les utilisateurs d'un domaine.

makeAdmin

 Désigne un utilisateur comme super-administrateur.

patch

 Met à jour un utilisateur à l'aide de la sémantique patch.

signOut

 Déconnecte un utilisateur de toutes les sessions sur le Web et sur l'appareil, et réinitialise ses cookies de connexion.

undelete

 Annule la suppression d'un compte utilisateur.

update

 Met à jour un utilisateur.

watch

 Surveille les changements dans la liste des utilisateurs.