--- sourceDocument: Référence de l’API Xanadu sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/fr-FR/xanadu/api-reference Release : - xanadu ft:locale : - fr-FR ft:publication_title : - Référence de l’API Xanadu ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # Système d'API SCIM (Cross-domain Identity Management) # Système d'API SCIM (Cross-domain Identity Management) {#ariaid-title1} * Rversion finale: Xanadu * * Mis à jour 1 août 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 132 minutes de lecture L'API SCIM (System for Cross-domain Identity Management) fournit des points de terminaison pour créer, lire, mettre à jour et supprimer des opérations sur les utilisateurs et les groupes à l'aide du protocole SCIM. Le protocole SCIM est un protocole basé sur HTTP au niveau de l'application basé sur la norme HTTP \[[RFC7230](https://datatracker.ietf.org/doc/html/rfc7230)\]. Utilisez cette API pour provisionner et gérer les données d'identité, telles que les utilisateurs et les groupes, sur le Web et dans les environnements inter-domaines, tels que les fournisseurs de services d'entreprise à cloud ou les scénarios inter-cloud. Pour accéder à cette API, vous devez activer le module d'extension SCIM v2 - ServiceNow® Cross-domain Identity Management (com.snc.integration.scim2). ## Mappage des ressources Le service SCIM dispose de six ressources : * Utilisateur (principal et extension) * Groupe (principal et extension) * Société * CostCenter * Département * Emplacement {#scim-api__ul_xp5_mjv_hrb}La plupart des attributs de ces ressources SCIM sont mappés aux champs correspondants d'une table existante ServiceNow . Les tables suivantes définissent ces mappages. Les attributs qui ne correspondent pas aux champs des tables existantes ServiceNow sont mappés à deux tables spécifiques à SCIM. Pour plus d'informations sur ces tables, [reportez-vous à la section Tables spécifiques à SCIM](https://servicenow-prod.fluidtopics.net/y7MC0a4VkotHcZWBN~pOzA#scim-api "L’API SCIM (System for Cross-domain Identity Management) fournit des points de terminaison pour créer, lire, mettre à jour et supprimer des opérations sur les utilisateurs et les groupes à l’aide du protocole SCIM."). La ressource Utilisateur SCIM comporte à la fois des schémas principaux (schéma : urn :ietf :params :scim :schemas :core :2.0 :User) et d'extension (urn :ietf :params :scim :schemas :extension :servicenow :2.0 :User). La plupart des attributs de schéma d'utilisateur principal et d'extension sont mappés à la table Utilisateur \[sys_user\]. {#scim-api__table_tdp_3ch_mrb__entry__2} | Nom de l'attribut SCIM | Nom de champ d'utilisateur | |-|-| | Actif | Actif | | adresses.pays | pays | | addresses.default.country | pays | | addresses.home.country | pays | | adresses.localité | city | | adresses.défaut.localité | city | | adresses.domicile.localité | city | | addresses.postalCode | code postal | | adresses.default.postalCode | code postal | | addresses.home.postalCode | code postal | | adresses.région | État | | adresses.default.region | État | | adresses.domicile.région | État | | adresses.rueadresse | rue | | adresses.default.streetAddress | rue | | adresses.domicile.rueAdresse | rue | | displayName | nom | | e-mails.valeur | E-mail | | emails.default.value | E-mail | | e-mails.travail.valeur | E-mail | | id | sys_id | | meta.created | sys_created_on | | meta.lastModified | sys_updated_on | | nom.nom.nom de famille | last_name | | nom.nomdonné | first_name | | nom.honorificPrefix | Introduction | | nom.deuxième prénom | middle_name | | phoneNumbers.value | Téléphone | | téléphoneNuméros.accueil.valeur | home_phone | | téléphone.mobile.valeur | mobile_phone | | téléphoneNuméros.travail.valeur | Téléphone | | preferredLanguage | preferred_language | | fuseau horaire | time_zone | | Titre | Titre | | userName | user_name | [Tableau 1. Mappage de ressource utilisateur à la table Utilisateur \[sys_user\]] {#scim-api__table_tdp_3ch_mrb} {#scim-api__table_a32_jch_mrb__entry__2} | Nom de l'attribut SCIM | Sys Scim Nom de champ d'utilisateur | |-|-| | externalId | external_id | [Tableau 2. Mappage de ressource utilisateur vers la table Utilisateur Sys Scim \[sys_scim_user\]] {#scim-api__table_a32_jch_mrb} Le schéma étendu de l'utilisateur SCIM (urn :ietf :params :scim :schemas :extension :servicenow :2.0 :User) est mappé à la table Utilisateur \[sys_user\]. {#scim-api__table_uvm_jch_mrb__entry__2} | Nom de l'attribut SCIM | Nom de champ d'utilisateur | |-|-| | company.name | company.name | | entreprise.valeur | company.sys_id | | costCenter.name | cost_center.name | | centre-coûts.valeur | cost_center.sys_id | | department.name | department.name | | valeur.département | department.sys_id | | employeeNumber | employee_number | | sexe | sexe | | location.name | location.name | | Emplacement.valeur | location.sys_id | | manager.displayName | manager.name | | gestionnaire.valeur | manager.sys_id | [Tableau 3. Mappage de la ressource étendue de l'utilisateur à la table de l'utilisateur \[sys_user\]] {#scim-api__table_uvm_jch_mrb} Le schéma de ressources de groupe SCIM (urn :ietf :params :scim :schemas :core :2.0 :Group) est mappé à la table Groupe \[sys_user_group\]. {#scim-api__table_typ_gkv_hrb__entry__2} | Nom de l'attribut SCIM | Nom de champ de groupe | |-|-| | displayName | nom | | id | sys_id | | meta.created | sys_created_on | | meta.lastModified | sys_updated_on | [Tableau 4. Mappage de la ressource de groupe à la table de groupe \[sys_user_group\]] {#scim-api__table_typ_gkv_hrb} Le paramètre externalId du groupe SCIM est mappé à la table du groupe Sys Scim \[sys_scim_group\]. {#scim-api__table_h54_kch_mrb__entry__2} | Nom de l'attribut SCIM | Nom de champ du groupe Sys Scim | |-|-| | externalId | external_id | [Tableau 5. Mappage d'une ressource de groupe à un groupe Sys Scim \[sys_scim_group\]] {#scim-api__table_h54_kch_mrb} Le schéma d'extension du groupe ServiceNow SCIM (urn :ietf :params :scim :schemas :extension :servicenow :2.0 :Group) est mappé à la table Groupe \[sys_user_group\]. {#scim-api__table_ugn_1rn_ftb__entry__2} | Nom de l'attribut SCIM | Nom de champ de groupe | |-|-| | entreprise.valeur | company.sys_id | | company.name | company.name | [Tableau 6. Mappage de la ressource de groupe à la table de groupe \[sys_user_group\]] {#scim-api__table_ugn_1rn_ftb} Le schéma de ressources de société SCIM (urn :ietf :params :scim :schemas :custom :servicenow :2.0 :Company) est mappé à la table Société \[core_company\]. {#scim-api__table_wpv_kch_mrb__entry__2} | Nom de l'attribut SCIM | Nom du champ de la société | |-|-| | id | sys_id | | meta.created | sys_created_on | | meta.lastModified | sys_updated_on | | nom | nom | [Tableau 7. Mappage de la ressource de l'entreprise à la table de l'entreprise \[core_company\]] {#scim-api__table_wpv_kch_mrb} Le schéma de ressources du Centre de coûts SCIM (urn :ietf :params :scim :schemas :custom :servicenow :2.0 :CostCenter) est mappé à la table Centre de coûts \[cmn_cost_center\]. {#scim-api__table_kxj_lch_mrb__entry__2} | Nom de l'attribut SCIM | Nom de champ Centre de coûts | |-|-| | id | sys_id | | meta.created | sys_created_on | | meta.lastModified | sys_updated_on | | nom | nom | [Tableau 8. Mappage de la ressource de centre de coûts à la table Centre de coûts \[cmn_cost_center\]] {#scim-api__table_kxj_lch_mrb} Le schéma de ressources du département SCIM (urn :ietf :params :scim :schemas :custom :servicenow :2.0 :Department) est mappé à la table du département \[cmn_department\]. {#scim-api__table_lks_lch_mrb__entry__2} | Nom de l'attribut SCIM | Nom de champ de département | |-|-| | id | sys_id | | meta.created | sys_created_on | | meta.lastModified | sys_updated_on | | nom | nom | [Tableau 9. Mappage de la ressource du département vers la table Département \[cmn_department\]] {#scim-api__table_lks_lch_mrb} Le schéma de ressource d'emplacement SCIM (urn :ietf :params :scim :schemas :custom :servicenow :2.0 :Location) est mappé à la table Emplacement \[cmn_location\]. {#scim-api__table_snf_mch_mrb__entry__2} | Nom de l'attribut SCIM | Nom du champ d'emplacement | |-|-| | id | sys_id | | meta.created | sys_created_on | | meta.lastModified | sys_updated_on | | nom | nom | [Tableau 10. Mappage de la ressource d'emplacement vers la table d'emplacement \[cmn_location\]] {#scim-api__table_snf_mch_mrb} ## Tables spécifiques à SCIM {#scim-api__SCIM_specific_tables-SCIM-table} Deux tables, Sys Scim User \[sys_scim_user\] et Sys Scim Group \[sys_scim_group\], contiennent les attributs SCIM qui ne sont pas mappés aux tables existantes ServiceNow . Les éléments suivants définissent le contenu de ces tables. {#scim-api__table_w2h_nch_mrb__entry__2} | Nom de champ | Description | |-|-| | Créé | Date et heure de création de l'enregistrement associé. Type de données : chaîne Longueur maximale : 40 | | Créé par | Nom de l'entité qui a créé l'enregistrement. Type de données : chaîne Longueur maximale : 40 | | ID externe | ID externe utilisé par l'entité qui a créé cet enregistrement d'utilisateur pour référencer l'utilisateur dans son système. Type de données : chaîne Longueur maximale : 255 | | ID système | Identificateur unique pour l'enregistrement au sein d'une ServiceNow instance. Type de données : chaîne Longueur maximale : 32 | | Mis à jour | Date et heure de dernière mise à jour de l'enregistrement associé. Type de données : chaîne Longueur maximale : 40 | | Mis à jour par | Nom de l'entité qui a mis à jour l'enregistrement associé pour la dernière fois. Type de données : chaîne Longueur maximale : 40 | | Mises à jour | Nombre de fois que l'enregistrement a été mis à jour. Type de données : entier Longueur maximale : 40 | | Utilisateur | Référence à l'utilisateur associé à cet enregistrement Référence : table de l'utilisateur \[sys_user\] Longueur maximale : 32 | | Type d'utilisateur | Type d'enregistrement utilisateur. Cette valeur est utilisée pour identifier la relation entre l'organisation et l'utilisateur. Il peut s'agir de n'importe quelle valeur, mais les valeurs typiques peuvent inclure : * Prestataire * Employé * Externe * Interne * Intérimaire * Inconnu {#scim-api__ul_kdr_nwz_nrb} Type de données : chaîne Longueur maximale : 40 | [Tableau 11. Table Utilisateur \[sys_scim_user\] Sys Scim] {#scim-api__table_w2h_nch_mrb} {#scim-api__table_mpt_nch_mrb__entry__2} | Nom de champ | Description | |-|-| | Créé | Date et heure de création de l'enregistrement associé. Type de données : chaîne Longueur maximale : 40 | | Créé par | Nom de l'entité qui a créé l'enregistrement. Type de données : chaîne Longueur maximale : 40 | | ID externe | ID externe utilisé par l'entité qui a créé cet enregistrement de groupe pour référencer le groupe dans son système. Type de données : chaîne Longueur maximale : 255 | | Groupe | Référence au groupe associé à cet enregistrement. Référence : table Groupe \[sys_user_group\] Longueur maximale : 32 | | ID système | Identificateur unique pour l'enregistrement au sein d'une ServiceNow instance. Type de données : chaîne Longueur maximale : 32 | | Mis à jour | Date et heure de dernière mise à jour de l'enregistrement associé. Type de données : chaîne Longueur maximale : 40 | | Mis à jour par | Nom de l'entité qui a mis à jour l'enregistrement associé pour la dernière fois. Type de données : chaîne Longueur maximale : 40 | | Mises à jour | Nombre de fois que l'enregistrement a été mis à jour. Type de données : entier Longueur maximale : 40 | [Tableau 12. Table Groupe Sys Scim \[sys_scim_group\]] {#scim-api__table_mpt_nch_mrb} ## Rôles et listes de contrôle d'accès Le rôle scim_admin est requis pour accéder aux tables spécifiques à SCIM et aux points de terminaison SCIM privés, et permet d'accéder aux tables Utilisateur \[sys_user\] et Groupe \[sys_user_group\]. Le service SCIM dispose de quatre ACL pour accéder à la table Utilisateur Sys Scim \[sys_scim_user\] et à la table Groupe Sys Scim \[sys_scim_group\] qui permettent de créer, de supprimer, de lire et d'écrire. Ces ACL sont uniquement mappées au rôle scim_admin. ## SCIM - DELETE /scim/groups/{group_id} {#ariaid-title2} Supprime l'enregistrement de groupe spécifié de la table Groupe \[sys_user_group\] d'une ServiceNow instance à l'aide du protocole SCIM (System for Cross-domain Identity Management). ### Format d'URL URL versionnée : /api/now/{api_version}/scim/groups/{group_id} URL par défaut : /api/now/scim/groups/{group_id} ### Paramètres de demande pris en charge {#scim-DELETE-Groups-group_id__entry__2}{#scim-DELETE-Groups-group_id__version-RESTAPI} | Nom | Description | |-|-| | api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne | | group_id | Sys_id de l'enregistrement du groupe à supprimer. Type de données : chaîne | [Tableau 13. Paramètres de chemin d'accès] {#scim-DELETE-Groups-group_id__entry__8} | Nom | Description | |-|-| | Aucun | | [Tableau 14. Paramètres de requête] {#scim-DELETE-Groups-group_id__entry__12} | Nom | Description | |-|-| | Aucun | | [Tableau 15. Paramètres du corps de la demande (JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-DELETE-Groups-group_id__entry__16}{#scim-DELETE-Groups-group_id__Accept-SCIM-entry} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/scim+json. Valeur par défaut : application/json | [Tableau 16. En-têtes de demandes] {#scim-DELETE-Groups-group_id__entry__20} | En-tête | Description | |-|-| | Aucun | | [Tableau 17. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-DELETE-Groups-group_id__entry__24}{#scim-DELETE-Groups-group_id__entry-200-status-code}{#scim-DELETE-Groups-group_id__entry-404-status-code} | Code d'état | Description | |-|-| | 204 | Aucun contenu. La demande a été correctement traitée. | | 404 | Introuvable. L'élément demandé est introuvable. | [Tableau 18. Codes d'état] ### Paramètres de corps de réponse (JSON) {#scim-DELETE-Groups-group_id__entry__30}{#scim-DELETE-Groups-group_id__errors-SCIM-entry}{#scim-DELETE-Groups-group_id__errors_details-SCIM-entry}{#scim-DELETE-Groups-group_id__errors_scimType-SCIM-entry}{#scim-DELETE-Groups-group_id__errors_schemas-SCIM-entry}{#scim-DELETE-Groups-group_id__errors_status-SCIM-entry} | Nom | Description | |-|-| | erreurs | Réponse décrivant toute erreur qui a pu se produire pendant le traitement de la demande. Type de données : objet "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" } | | errors.detail | Message d'erreur détaillé expliquant pourquoi la demande a échoué. Type de données : chaîne | | errors.scimType | Mot clé de détail de l'erreur SCIM. Type de données : chaîne | | Schémas.erreurs | URI des schémas SCIM utilisés pour traiter la réponse d'erreur. Type de données : tableau de chaînes | | erreurs.état | Code d'état HTTP de la réponse d'erreur. Type de données : chaîne | [ ] ### Demande cURL de suppression d'un groupe Cet exemple montre comment supprimer un enregistrement de groupe de la table Groupe \[sys_user_group\]. curl "https://instance-servicenow.com/api/now/scim/Groups/a0a9e9fb1b7e3010593876a61a4bcbe0" \ --request DELETE \ --header "Accept:application/scim+json" \ ## SCIM - GET /scim/Groups {#ariaid-title3} Renvoie un ou plusieurs enregistrements de groupe de la table Groupe \[sys_user_group\] au sein d'une ServiceNow instance utilisant le protocole SCIM (System for Cross-domain Identity Management). Remarque : Une requête qui ne renvoie aucune correspondance renvoie un message de réussite (code d'état HTTP 200) avec totalResults la valeur 0. ### Format d'URL URL versionnée : /api/now/{api_version}/scim/Groups URL par défaut : /api/now/scim/groups ### Paramètres de demande pris en charge {#scim-GET-Groups__entry__2}{#scim-GET-Groups__version-RESTAPI} | Nom | Description | |-|-| | api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne | [Tableau 19. Paramètres de chemin d'accès] {#scim-GET-Groups__entry__6}{#scim-GET-Groups__attributes-SCIM-entry}{#scim-GET-Groups__count-SCIM-entry}{#scim-GET-Groups__excludedAttributes-SCIM-entry}{#scim-GET-Groups__filter-SCIM-ph}{#scim-GET-Groups__group_sortBy-SCIM-entry}{#scim-GET-Groups__sortOrder-SCIM-entry}{#scim-GET-Groups__group_startIndex-SCIM-entry} | Nom | Description | |-|-| | attributs | Liste des champs séparés par des virgules à envoyer dans la réponse. Aucun autre champ n'est renvoyé. Ne peut pas être utilisé avec le excludedAttributes paramètre. Type de données : chaîne Par défaut : renvoie tous les champs sauf s'il excludedAttributes est spécifié. | | compter | Nombre d'enregistrements à renvoyer. Une valeur négative est interprétée comme zéro. Type de données : nombre Maximum : 500 : une valeur supérieure à cette valeur entraîne une erreur de demande incorrecte. Par défaut : 10 | | Attributs exclus | Liste de champs séparés par des virgules à exclure des enregistrements renvoyés dans la réponse. Tous les autres champs sont renvoyés. Ne peut pas être utilisé avec le attributes paramètre. Type de données : chaîne Par défaut : n'excluez aucun champ. | | filtre | Expression de filtre à appliquer aux résultats renvoyés. Les filtres de champ sont exprimés sous la forme ` <"valeur>`. Consultez [RFC7644](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2) pour obtenir la liste des opérateurs valides. Remarque : `L'opérateur NOT` n'est pas pris en charge par cette méthode. Par exemple, pour filtrer tous les groupes dont le nom commence par \<\< RH \>\>, entrez `displayName SW << RH >>.` Pour spécifier plusieurs filtres de champ, concaténez les filtres à l'aide de l'opérande `ET` . Par exemple, pour filtrer tous les groupes dont le nom commence par \<\< RH \>\> et dont la dernière modification a été effectuée avant le 3 octobre 2021, saisissez `displayName SW << HR >> ET meta.lastModified lt << 2021-10-33T00:00:00Z >>.` Utilisez la remontée pas à pas pour spécifier les attributs imbriqués. Seuls les champs de groupe SCIM suivants peuvent être utilisés dans les filtres : * displayName * externalId : ne prend en charge que l'opérateur `EQ` . * id * meta.created * meta.lastModified {#scim-GET-Groups__ul_szc_2cc_grb} Type de données : chaîne Par défaut : aucun filtrage | | trier par | Doit être spécifié avec le sortOrder paramètre. Champ utilisé pour trier les résultats renvoyés. Le tri n'est pas sensible à la casse. Vous ne pouvez utiliser que les paramètres disponibles pour le filtrage du sortBy paramètre, sauf si cela externalId n'est pas autorisé. Pour les valeurs nulles : * Trié par ordre croissant : les valeurs nulles sont triées tout en haut. * trié par ordre décroissant : les valeurs nulles sont triées en bas. {#scim-GET-Groups__ul_xsb_zmm_hrb} Type de données : chaîne Par défaut : aucun tri | | sortOrder | Doit être spécifié avec le sortBy paramètre. Ordre dans lequel le sortBy paramètre est appliqué aux résultats renvoyés. Valeurs valides : * ascendant * descendant {#scim-GET-Groups__ul_mmn_zrc_grb} Type de données : chaîne Par défaut : croissant | | startIndex | Index de base unique dans la table à partir de laquelle commencer à récupérer les enregistrements. Par exemple, si vous définissez ce paramètre sur 100 et le count paramètre sur 20, le point de terminaison renvoie les enregistrements 100 à 119. Remarque : Toute valeur qui est définie sur moins de un est interprétée comme un. Type de données : chaîne Valeur par défaut : 1 | [Tableau 20. Paramètres de requête] {#scim-GET-Groups__entry__22} | Nom | Description | |-|-| | Aucun | | [Tableau 21. Paramètres du corps de la demande (JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-GET-Groups__entry__26}{#scim-GET-Groups__Accept-SCIM-entry} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/scim+json. Valeur par défaut : application/json | [Tableau 22. En-têtes de demandes] {#scim-GET-Groups__entry__30} | En-tête | Description | |-|-| | Aucun | | [Tableau 23. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-GET-Groups__entry__34}{#scim-GET-Groups__entry-200-status-code}{#scim-GET-Groups__status_400-SCIM-entry}{#scim-GET-Groups__entry-401-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. * Assurez-vous que les paramètres de requête et excludedAttributes n'ont attributes pas été transmis dans la demande. * Assurez-vous que le paramètre n'est count pas supérieur à 500. * Assurez-vous que tous les filter paramètres sont valides. {#scim-GET-Groups__ul_vn1_gvz_nrb} | | 401 | Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises. | [Tableau 24. Codes d'état] ### Paramètres de corps de réponse (JSON) {#scim-GET-Groups__entry__42}{#scim-GET-Groups__itemsPerPage-SCIM-entry}{#scim-GET-Groups__totalResults-SCIM-entry} | Nom | Description | |-|-| | itemsPerPage | Nombre d'enregistrements renvoyés dans les résultats renvoyés. Type de données : nombre | | Ressources | Liste des enregistrements de groupe. Type de données : tableau d'objets "Resources": [ { "company": {Object}, "displayName": "String", "externalId": "String", "id": "String", "meta": [Array] } ] | | Ressources.société | Détails sur la société ou l'organisation du groupe. Type de données : objet "company": { "display": "String", "$ref": "String", "value": "String" } | | Ressources.entreprise.display | Nom de la société. Type de données : chaîne | | Ressources.entreprise.$ref | URI de référence de la société. Format : `/Entreprises/ de l'entreprise`, par exemple : `http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 `. Type de données : chaîne | | Ressources.entreprise.valeur | Sys_id de la société associée. Type de données : chaîne | | Resources.displayName | Nom explicite du groupe, par exemple Équipe RH. Type de données : chaîne | | Resources.externalId | Identificateur unique affecté au groupe par l'entité qui le provisionne. Type de données : chaîne | | Resources.id | Sys_id du groupe. Type de données : chaîne | | Ressources.meta | Métadonnées relatives au groupe. Type de données : objet "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" } | | Ressources.meta.créé | Date et heure de création de l'enregistrement de groupe. Type de données : chaîne | | Ressources.meta.lastModified | Date et heure de la dernière modification de l'enregistrement de groupe. Type de données : chaîne | | Ressources.meta.location | URI du groupe en cours de récupération. Type de données : chaîne | | Resources.meta.resourceType | Type de ressource des groupes SCIM. Type de données : chaîne | | Ressources.membres | Liste des utilisateurs et des groupes associés au groupe. Type de données : tableau d'objets "members": [ { "display": "String", "value": "String", "$ref": "String" } ] | | Ressources.membres.display | Nom du membre du groupe associé. Type de données : chaîne | | Ressources.membres.valeur | Sys_id de l'enregistrement d'utilisateur ou de groupe associé. Type de données : chaîne | | Ressources.membres.$ref | URI du membre de groupe associé. Type de données : chaîne | | Resources.schemas | Liste des URI du groupe SCIM schémas utilisés pour traiter la demande. Schémas de groupe pris en charge : * urn :ietf :params :scim :schemas :core :2.0 :Group : schéma de base spécifié dans le système du groupe de travail d'ingénierie Internet pour la gestion des identités inter-domaines : document de schéma principal () * urn :ietf :params :scim :schemas :extension :servicenow :2.0 :Group : schéma d'extension ServiceNow . Ce schéma contient des attributs qui sont présents dans la table Groupes \[sys_user_group\] d'un système de base ServiceNow , mais qui ne font pas partie du schéma principal. * urn :ietf :params :scim :schemas :extension :servicenow :custom :2.0 :Group" : schéma d'extension personnalisé. Ce schéma fait partie de resourceType \<\< Groupe \>\> dans la table sys_scim_schema_extension. Si le schéma n'est pas actif, l'URN du schéma n'est pas renvoyé dans la réponse. {#scim-GET-Groups__ul_ckx_x3t_2tb} Type de données : tableau de chaînes | | Schémas | Liste des URI de la liste SCIM Schémas de réponse utilisés pour traiter la demande. Type de données : tableau | | startIndex | Index de base unique dans la table Groupe \[sys_user_group\] dans laquelle le point de terminaison a commencé à récupérer des enregistrements. Type de données : nombre | | totalResults | Nombre total d'enregistrements qui correspondent à la demande. Type de données : nombre | [ ] ### Demande cURL pour plusieurs groupes Cet exemple montre comment demander plusieurs groupes (quatre dans ce cas), à l'aide du count paramètre. curl "https://instance-sevicenow.com/api/now/scim/Groups?count=4" \ --request GET \ --header "Accept:application/scim+json" \ Réponse : {"schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"], "totalResults":44, "Resources":[ {"schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group"", "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group", "urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group" ], "id":"019ad92ec7230010393d265c95c260dd", "meta":{ "resourceType":"Group", "created":"2020-03-17T11:39:14Z", "lastModified":"2020-03-17T11:39:14Z", "location":"https://instance-sevicenow.com/api/now/scim/Groups/019ad92ec7230010393d265c95c260dd" }, "displayName":"Analytics Settings Managers" }, {"schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group"", "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group", "urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group" ], "id":"0a52d3dcd7011200f2d224837e6103f2", "meta":{ "resourceType":"Group", "created":"2021-09-29T16:42:02Z", "lastModified":"2021-09-29T16:42:02Z", "location":"https://instance-sevicenow.com/api/now/scim/Groups/0a52d3dcd7011200f2d224837e6103f2" }, "displayName":"Application Development", "members":[ { "value":"dc6053dcd7011200f2d224837e6103e0", "display":"John Doe", "$ref": "http://instance-sevicenow.com/api/now/scim/Users/dc6053dcd7011200f2d224837e6103e0" }, { "value":"443193dcd7011200f2d224837e61037d", "display":"Abel Tutor", "$ref": "http://instance-sevicenow.com/api/now/scim/Users/443193dcd7011200f2d224837e61037d" } ], "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group": { "company": { "value": "81fd65ecac1d55eb42a426568fc87a63", "name": "ACME Japan", "$ref": "http://instance-sevicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63" } } }, {"schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group"", "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group", "urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group" ], "id":"0c4e7b573b331300ad3cc9bb34efc461", "meta":{ "resourceType":"Group", "created":"2021-09-29T05:11:33Z", "lastModified":"2021-09-29T05:11:33Z", "location":"instance-sevicenow.com/api/now/scim/Groups/0c4e7b573b331300ad3cc9bb34efc461" }, "displayName":"Problem Analyzers", "members":[ { "value":"d3dbbf173b331300ad3cc9bb34efc466", "display":"Problem Manager", "$ref": "http://instance-sevicenow.com/api/now/scim/Users/babb4639b76233004fbc2089ee11a97f" }, { "value":"38cb3f173b331300ad3cc9bb34efc4d6", "display":"Problem Coordinator B", "$ref": "http://instance-sevicenow.com/api/now/scim/Users/cbcc4639b76233004fbc2089ee111047" }, { "value":"26fbff173b331300ad3cc9bb34efc4bd", "display":"Problem Administrator", "$ref": "http://instance-sevicenow.com/api/now/scim/Users/45324639b76232189fbc2089ee11bc34" } ], "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group": { "company": { "value": "913465ecac1d569b42a426568fc88af3", "name": "ACME London", "$ref": "http://instance-sevicenow.com/api/now/scim/Companies/913465ecac1d569b42a426568fc88af3" } } }, {"schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group"", "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group", "urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group" ], "id":"0c5e2a7ce4001410f877ce457cda6b98", "meta":{ "resourceType":"Group", "created":"2020-04-06T03:47:08Z", "lastModified":"2020-07-29T04:02:26Z", "location":"instance-sevicenow.com/api/now/scim/Groups/0c5e2a7ce4001410f877ce457cda6b98" }, "displayName":"Business Application Registration Approval Group" } ], "startIndex":1, "itemsPerPage":4 } ### Demande cURL pour plusieurs groupes utilisant excludedAttributes Cet exemple montre comment demander plusieurs groupes (quatre dans ce cas), en utilisant le count paramètre et en excluant les champs meta et members. curl "https://instance-sevicenow.com/api/now/scim/Groups?excludedAttributes=meta%2C%20members&count=4" \ --request GET \ --header "Accept:application/scim+json" \ Réponse : {"schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"], "totalResults":44, "Resources":[ {"schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group"", "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group", "urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group" ], "id":"019ad92ec7230010393d265c95c260dd", "displayName":"Analytics Settings Managers", "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group": { "company": { "value": "913465ecac1d569b42a426568fc88af3", "name": "ACME London", "$ref": "http://instance-sevicenow.com/api/now/scim/Companies/913465ecac1d569b42a426568fc88af3" } } }, {"schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group"", "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group", "urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group" ], "id":"0a52d3dcd7011200f2d224837e6103f2", "displayName":"Application Development" }, {"schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group"", "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group", "urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group" ], "id":"0c4e7b573b331300ad3cc9bb34efc461", "displayName":"Problem Analyzers" }, {"schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group"", "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group", "urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group" ], "id":"0c5e2a7ce4001410f877ce457cda6b98", "displayName":"Business Application Registration Approval Group", "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group": { "company": { "value": "81fd65ecac1d55eb42a426568fc87a63", "name": "ACME Japan", "$ref": "http://instance-sevicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63" } } } ], "startIndex":1, "itemsPerPage":4 } ## SCIM - GET /scim/groups/{group_id} {#ariaid-title4} Renvoie l'enregistrement de groupe spécifié à partir de la table Groupe \[sys_user_group\] au sein d'une ServiceNow instance utilisant le protocole SCIM (System for Cross-domain Identity Management). ### Format d'URL URL versionnée : /api/now/{api_version}/scim/groups/{group_id} URL par défaut : /api/now/scim/groups/{group_id} ### Paramètres de demande pris en charge {#scim-GET-Groups-group_id__entry__2}{#scim-GET-Groups-group_id__version-RESTAPI} | Nom | Description | |-|-| | api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne | | group_id | Sys_id de l'enregistrement de groupe à renvoyer. | [Tableau 25. Paramètres de chemin d'accès] {#scim-GET-Groups-group_id__entry__8}{#scim-GET-Groups-group_id__attributes-SCIM-entry}{#scim-GET-Groups-group_id__excludedAttributes-SCIM-entry} | Nom | Description | |-|-| | attributs | Liste des champs séparés par des virgules à envoyer dans la réponse. Aucun autre champ n'est renvoyé. Ne peut pas être utilisé avec le excludedAttributes paramètre. Type de données : chaîne Par défaut : renvoie tous les champs sauf s'il excludedAttributes est spécifié. | | Attributs exclus | Liste de champs séparés par des virgules à exclure des enregistrements renvoyés dans la réponse. Tous les autres champs sont renvoyés. Ne peut pas être utilisé avec le attributes paramètre. Type de données : chaîne Par défaut : n'excluez aucun champ. | [Tableau 26. Paramètres de requête] {#scim-GET-Groups-group_id__entry__14} | Nom | Description | |-|-| | Aucun | | [Tableau 27. Paramètres du corps de la demande (JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-GET-Groups-group_id__entry__18}{#scim-GET-Groups-group_id__Accept-SCIM-entry} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/scim+json. Valeur par défaut : application/json | [Tableau 28. En-têtes de demandes] {#scim-GET-Groups-group_id__entry__22} | En-tête | Description | |-|-| | Aucun | | [Tableau 29. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-GET-Groups-group_id__entry__26}{#scim-GET-Groups-group_id__entry-200-status-code}{#scim-GET-Groups-group_id__status_400-SCIM-entry}{#scim-GET-Groups-group_id__entry-404-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. * Assurez-vous que les paramètres de requête et excludedAttributes n'ont attributes pas été transmis dans la demande. * Assurez-vous que le paramètre n'est count pas supérieur à 500. * Assurez-vous que tous les filter paramètres sont valides. {#scim-GET-Groups-group_id__ul_vn1_gvz_nrb} | | 404 | Introuvable. L'élément demandé est introuvable. | [Tableau 30. Codes d'état] ### Paramètres de corps de réponse (JSON) {#scim-GET-Groups-group_id__id_uwk_c5c_grb__entry__2}{#scim-GET-Groups-group_id__group_company-SCIM-entry}{#scim-GET-Groups-group_id__group_company_display-SCIM-entry}{#scim-GET-Groups-group_id__group_company_ref-SCIM-entry}{#scim-GET-Groups-group_id__group_company_value-SCIM-entry}{#scim-GET-Groups-group_id__group_displayName-SCIM-entry}{#scim-GET-Groups-group_id__group_externalId-SCIM-entry}{#scim-GET-Groups-group_id__group_id-SCIM-entry}{#scim-GET-Groups-group_id__group_meta-SCIM-entry}{#scim-GET-Groups-group_id__group_meta_created-SCIM-entry}{#scim-GET-Groups-group_id__group_meta_lastModified-SCIM-entry}{#scim-GET-Groups-group_id__group_meta_location-SCIM-entry}{#scim-GET-Groups-group_id__group_meta_resourceType-SCIM-entry}{#scim-GET-Groups-group_id__group_members-SCIM-entry}{#scim-GET-Groups-group_id__group_members_display-SCIM-entry}{#scim-GET-Groups-group_id__group_members_value-SCIM-entry}{#scim-GET-Groups-group_id__group_members_ref-SCIM-entry}{#scim-GET-Groups-group_id__group_schemas-SCIM-entry} | Nom | Description | |-|-| | company | Détails sur la société ou l'organisation du groupe. Type de données : objet "company": { "display": "String", "$ref": "String", "value": "String" } | | entreprise.display | Nom de la société. Type de données : chaîne | | entreprise.$ref | URI de référence de la société. Format : `/Entreprises/ de l'entreprise`, par exemple : `http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 `. Type de données : chaîne | | entreprise.valeur | Sys_id de la société associée. Type de données : chaîne | | displayName | Nom explicite du groupe, par exemple Équipe RH. Type de données : chaîne | | externalId | Identificateur unique affecté au groupe par l'entité qui le provisionne. Type de données : chaîne | | id | Sys_id du groupe. Type de données : chaîne | | métadonnées | Métadonnées relatives au groupe. Type de données : objet "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" } | | meta.created | Date et heure de création de l'enregistrement de groupe. Type de données : chaîne | | meta.lastModified | Date et heure de la dernière modification de l'enregistrement de groupe. Type de données : chaîne | | meta.location | URI du groupe en cours de récupération. Type de données : chaîne | | meta.resourceType | Type de ressource des groupes SCIM. Type de données : chaîne | | membres | Liste des utilisateurs et des groupes associés au groupe. Type de données : tableau d'objets "members": [ { "display": "String", "value": "String", "$ref": "String" } ] | | membres.display | Nom du membre du groupe associé. Type de données : chaîne | | membres.valeur | Sys_id de l'enregistrement d'utilisateur ou de groupe associé. Type de données : chaîne | | membres.$ref | URI du membre de groupe associé. Type de données : chaîne | | Schémas | Liste des URI du groupe SCIM schémas utilisés pour traiter la demande. Schémas de groupe pris en charge : * urn :ietf :params :scim :schemas :core :2.0 :Group : schéma de base spécifié dans le système du groupe de travail d'ingénierie Internet pour la gestion des identités inter-domaines : document de schéma principal () * urn :ietf :params :scim :schemas :extension :servicenow :2.0 :Group : schéma d'extension ServiceNow . Ce schéma contient des attributs qui sont présents dans la table Groupes \[sys_user_group\] d'un système de base ServiceNow , mais qui ne font pas partie du schéma principal. * urn :ietf :params :scim :schemas :extension :servicenow :custom :2.0 :Group" : schéma d'extension personnalisé. Ce schéma fait partie de resourceType \<\< Groupe \>\> dans la table sys_scim_schema_extension. Si le schéma n'est pas actif, l'URN du schéma n'est pas renvoyé dans la réponse. {#scim-GET-Groups-group_id__ul_ckx_x3t_2tb} Type de données : tableau de chaînes | [ ] {#scim-GET-Groups-group_id__id_uwk_c5c_grb} ### Demande cURL pour un groupe spécifique Cet exemple montre comment récupérer un enregistrement de groupe spécifique. curl "https://instance-servicenow.com/api/now/scim/Groups/e0140d671bbe3010593876a61a4bcb11" \ --request GET \ --header "Accept:application/scim+json" \ Réponse : {"schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group", "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group", "urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group" ], "id":"e0140d671bbe3010593876a61a4bcb11", "externalId":"8ae5dc9e-c7ad-4d3d-a152-35a6b6222b83", "meta":{ "resourceType":"Group", "created":"2021-09-30T18:20:43Z", "lastModified":"2021-09-30T18:20:43Z", "location":"https://instance-servicenow.com/api/now/scim/Groups/e0140d671bbe3010593876a61a4bcb11"}, "displayName":"HR Group", "members":[ { "value":"62826bf03710200044e0bfc8bcbe5df1", "display":"Abel Tuter", "$ref": "http://instance-servicenow.com/api/now/scim/Users/62826bf03710200044e0bfc8bcbe5df1" } ], "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group": { "company": { "value": "81fd65ecac1d55eb42a426568fc87a63", "name": "ACME Japan", "$ref": "http://111.111.1.11:8080/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63" } } } } ## SCIM - PATCH /scim/Groups/{group_id} {#ariaid-title5} Permet d'ajouter, de mettre à jour et de supprimer des champs spécifiés dans un enregistrement de groupe dans la table Groupe \[sys_user_group\] d'une ServiceNow instance utilisant le protocole SCIM (System for Cross-domain Identity Management). Pour plus d'informations, reportez-vous à la section [Modification avec PATCH](https://datatracker.ietf.org/doc/html/rfc7644#section-3.5.2) de la RFC 7644. ### Format d'URL URL versionnée : /api/now/{api_version}/scim/groups/{group_id} URL par défaut : /api/now/scim/groups/{group_id} ### Paramètres de demande pris en charge {#scim-PATCH-Groups-group_id__entry__2}{#scim-PATCH-Groups-group_id__version-RESTAPI} | Nom | Description | |-|-| | api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne | | group_id | Sys_id de l'enregistrement de groupe à mettre à jour. | [Tableau 31. Paramètres de chemin d'accès] {#scim-PATCH-Groups-group_id__entry__8}{#scim-PATCH-Groups-group_id__attributes-SCIM-entry}{#scim-PATCH-Groups-group_id__excludedAttributes-SCIM-entry} | Nom | Description | |-|-| | attributs | Liste des champs séparés par des virgules à envoyer dans la réponse. Aucun autre champ n'est renvoyé. Ne peut pas être utilisé avec le excludedAttributes paramètre. Type de données : chaîne Par défaut : renvoie tous les champs sauf s'il excludedAttributes est spécifié. | | Attributs exclus | Liste de champs séparés par des virgules à exclure des enregistrements renvoyés dans la réponse. Tous les autres champs sont renvoyés. Ne peut pas être utilisé avec le attributes paramètre. Type de données : chaîne Par défaut : n'excluez aucun champ. | [Tableau 32. Paramètres de requête] {#scim-PATCH-Groups-group_id__entry__14}{#scim-PATCH-Groups-group_id__group_schemas-SCIM-entry} | Nom | Description | |-|-| | Opérations | Requis. Liste des objets d'opération avec lesquels appliquer un correctif à l'enregistrement de groupe spécifié. Type de données : tableau d'objets "Operations": [ { "op": "String", "path": "String", "value": Any } ] | | Opérations.op | Requis. Opération à effectuer. Valeurs valides : * ajouter : ajouter le champ et la valeur spécifiés à l'enregistrement du groupe. * Supprimer : supprimez la valeur du champ spécifié. Remplacé par le type de données \<\< null \>\>. * remplacer : remplacez la valeur du champ spécifié. Type de données : chaîne | | Chemin.Opérations.Chemin d'accès | Obligatoire pour `les opérations de suppression` , facultatif pour les autres. Nom/chemin d'accès du champ à modifier. Le path paramètre peut avoir l'un des formats suivants : * Un champ direct, tel que `displayName` * Dans le cas d'un tableau complexe, un pointeur vers un élément spécifique avec un filtre, tel que : `emails[type eq << work"]` {#scim-PATCH-Groups-group_id__ul_zpv_ls5_frb} { "schemas": [ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ], "Operations": [ { "op": "add", "path": "displayName", "value": "HR Group" }, { "op": "replace", "path": "members[value eq \"sysid1\"]", "value": { "value": "sysid2" } } ] } Type de données : chaîne Par défaut : considère le champ comme une ressource. | | Operations.value | Valeur du champ spécifié dans le Operations.path paramètre. Le format de ce paramètre dépend du type de données du champ associé. Par exemple, si vous mettez à jour une chaîne simple, telle que le titre, le value champ est exprimé sous forme de chaîne. "Operations": [ { "op": "add", "path": "displayName", "value": "HR Group" } ] Vous pouvez également déclarer des valeurs de chaîne simples sans path paramètres, telles que : "Operations": [ { "op": "add", "value": { "displayName": "HR Group" } } ] Vous trouverez ci-dessous comment ajouter un membre au groupe : { "op": "add", "value": { "members": { "value": "62826bf03710200044e0bfc8bcbe5df1", } } } Si le champ mis à jour n'est pas dans le schéma de base, vous devez entourer la paire nom-valeur dans un objet qui spécifie l'URN du schéma associé. "value": { "": { "": "" }, } Par exemple : "value": { "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group": { "groupNumber": "13454" }, } Type de données : N'importe lequel | | Opération.valeur.type | Nom du champ à mettre à jour. Type de données : chaîne | | Opérations.valeur.valeur | Valeur avec laquelle mettre à jour le champ. Type de données : chaîne | | Schémas | Requis. URI de schéma SCIM de l'opération de correctif : \<\< urn :ietf :params :scim :api :messages :2.0 :PatchOp \>\> Type de données : chaîne | [Tableau 33. Paramètres du corps de la demande (JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-PATCH-Groups-group_id__entry__30}{#scim-PATCH-Groups-group_id__Accept-SCIM-entry}{#scim-PATCH-Groups-group_id__Content_Type-SCIM-entry} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/scim+json. Valeur par défaut : application/json | | Content-Type | Format de données du corps de la demande. Types pris en charge : application/json ou application/scim+json. Valeur par défaut : application/json | [Tableau 34. En-têtes de demandes] {#scim-PATCH-Groups-group_id__entry__36} | En-tête | Description | |-|-| | Aucun | | [Tableau 35. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-PATCH-Groups-group_id__entry__40}{#scim-PATCH-Groups-group_id__entry-200-status-code}{#scim-PATCH-Groups-group_id__entry-404-status-code}{#scim-PATCH-Groups-group_id__entry-500-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 204 | Réussi. Aucun contenu (applicable uniquement pour l'API du correctif de groupe SCIM) : cet état 204 dépend de l'état de la propriété d'interface utilisateur SCIM, `Activer la réponse de l'API du correctif de groupe sans contenu`, et est soumis au paramètre d'attribut transmis selon la RFC : . Valeur de propriété par défaut : false La propriété `Activer la réponse de l'API du correctif de groupe sans contenu` peut être utilisée pour obtenir des gains de performance d'exécution de réponse supplémentaires si le client ne prévoit pas de consommer de ressources de réponse. | | 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. * Vérifier les valeurs non valides : * Corps de demande mal formé. * Le champ obligatoire n'est pas fourni ou vide. * Un sys_id d'utilisateur ou de groupe non valide est fourni. * Vérifiez si un champ en lecture seule ou immuable essaie d'être modifié. * Assurez-vous que les paramètres de requête et excludedAttributes n'ont attributes pas été transmis dans la demande ou que la demande ne dépasse pas le nombre maximal de membres. {#scim-PATCH-Groups-group_id__status_400_extended-SCIM-entry} | | 404 | Introuvable. L'élément demandé est introuvable. | | 409 | Le groupe existe déjà. Le displayName paramètre doit être unique. | | 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. | [Tableau 36. Codes d'état] ### Paramètres de corps de réponse (JSON) {#scim-PATCH-Groups-group_id__entry__54}{#scim-PATCH-Groups-group_id__group_company-SCIM-entry}{#scim-PATCH-Groups-group_id__group_company_display-SCIM-entry}{#scim-PATCH-Groups-group_id__group_company_ref-SCIM-entry}{#scim-PATCH-Groups-group_id__group_company_value-SCIM-entry}{#scim-PATCH-Groups-group_id__group_displayName-SCIM-entry}{#scim-PATCH-Groups-group_id__group_externalId-SCIM-entry}{#scim-PATCH-Groups-group_id__errors-SCIM-entry}{#scim-PATCH-Groups-group_id__errors_details-SCIM-entry}{#scim-PATCH-Groups-group_id__errors_scimType-SCIM-entry}{#scim-PATCH-Groups-group_id__errors_schemas-SCIM-entry}{#scim-PATCH-Groups-group_id__errors_status-SCIM-entry}{#scim-PATCH-Groups-group_id__d2938e891}{#scim-PATCH-Groups-group_id__d2938e903}{#scim-PATCH-Groups-group_id__group_id-SCIM-entry}{#scim-PATCH-Groups-group_id__group_members-SCIM-entry}{#scim-PATCH-Groups-group_id__group_members_display-SCIM-entry}{#scim-PATCH-Groups-group_id__group_members_value-SCIM-entry}{#scim-PATCH-Groups-group_id__group_members_ref-SCIM-entry}{#scim-PATCH-Groups-group_id__group_meta-SCIM-entry}{#scim-PATCH-Groups-group_id__group_meta_created-SCIM-entry}{#scim-PATCH-Groups-group_id__group_meta_lastModified-SCIM-entry}{#scim-PATCH-Groups-group_id__group_meta_location-SCIM-entry}{#scim-PATCH-Groups-group_id__group_meta_resourceType-SCIM-entry}{#scim-PATCH-Groups-group_id__d2938e1030} | Nom | Description | |-|-| | company | Détails sur la société ou l'organisation du groupe. Type de données : objet "company": { "display": "String", "$ref": "String", "value": "String" } | | entreprise.display | Nom de la société. Type de données : chaîne | | entreprise.$ref | URI de référence de la société. Format : `/Entreprises/ de l'entreprise`, par exemple : `http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 `. Type de données : chaîne | | entreprise.valeur | Sys_id de la société associée. Type de données : chaîne | | displayName | Nom explicite du groupe, par exemple Équipe RH. Type de données : chaîne | | externalId | Identificateur unique affecté au groupe par l'entité qui le provisionne. Type de données : chaîne | | erreurs | Réponse décrivant toute erreur qui a pu se produire pendant le traitement de la demande. Type de données : objet "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" } | | errors.detail | Message d'erreur détaillé expliquant pourquoi la demande a échoué. Type de données : chaîne | | errors.scimType | Mot clé de détail de l'erreur SCIM. Type de données : chaîne | | Schémas.erreurs | URI des schémas SCIM utilisés pour traiter la réponse d'erreur. Type de données : tableau de chaînes | | erreurs.état | Code d'état HTTP de la réponse d'erreur. Type de données : chaîne | | displayName | Nom explicite du groupe, par exemple Équipe RH. Type de données : chaîne | | externalId | Identificateur unique affecté au groupe par l'entité qui le provisionne. Type de données : chaîne | | id | Sys_id du groupe. Type de données : chaîne | | membres | Liste des utilisateurs et des groupes associés au groupe. Type de données : tableau d'objets "members": [ { "display": "String", "value": "String", "$ref": "String" } ] | | membres.display | Nom du membre du groupe associé. Type de données : chaîne | | membres.valeur | Sys_id de l'enregistrement d'utilisateur ou de groupe associé. Type de données : chaîne | | membres.$ref | URI du membre de groupe associé. Type de données : chaîne | | métadonnées | Métadonnées relatives au groupe. Type de données : objet "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" } | | meta.created | Date et heure de création de l'enregistrement de groupe. Type de données : chaîne | | meta.lastModified | Date et heure de la dernière modification de l'enregistrement de groupe. Type de données : chaîne | | meta.location | URI du groupe en cours de récupération. Type de données : chaîne | | meta.resourceType | Type de ressource des groupes SCIM. Type de données : chaîne | | Schémas | Liste des URI du groupe SCIM schémas utilisés pour traiter la demande. Schémas de groupe pris en charge : * urn :ietf :params :scim :schemas :core :2.0 :Group : schéma de base spécifié dans le système du groupe de travail d'ingénierie Internet pour la gestion des identités inter-domaines : document de schéma principal () * urn :ietf :params :scim :schemas :extension :servicenow :2.0 :Group : schéma d'extension ServiceNow . Ce schéma contient des attributs qui sont présents dans la table Groupes \[sys_user_group\] d'un système de base ServiceNow , mais qui ne font pas partie du schéma principal. * urn :ietf :params :scim :schemas :extension :servicenow :custom :2.0 :Group" : schéma d'extension personnalisé. Ce schéma fait partie de resourceType \<\< Groupe \>\> dans la table sys_scim_schema_extension. Si le schéma n'est pas actif, l'URN du schéma n'est pas renvoyé dans la réponse. {#scim-PATCH-Groups-group_id__ul_ckx_x3t_2tb} Type de données : tableau de chaînes | [ ] ### Demande cURL Cet exemple montre comment ajouter un ID externe à un enregistrement de groupe et remplacer la liste actuelle des membres (utilisateurs) associés. curl "https://instance-servicenow.com/api/now/scim/Groups/a92b84f96b073010638c83eece44af4e" \ --request PATCH \ --header "Accept:application/scim+json" \ --header "Content-Type:application/scim+json" \ --data "{ "schemas": [ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ], "Operations": [ { "op": "add", "path": "externalId", "value": "278fdc2e-a6aa-4140-bd23-9ba4987a2938" }, { "op": "replace", "path": "members", "value": [ { "value": "62826bf03710200044e0bfc8bcbe5df1" }, { "value": "a8f98bb0eb32010045e1a5115206fe3a" } ] } ] }" Réponse : { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group", "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group", 'urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group' ], "id": "a92b84f96b073010638c83eece44af4e", "externalId": "278fdc2e-a6aa-4140-bd23-9ba4987a2938", "meta": { "resourceType": "Group", "created": "2021-10-07T13:58:22Z", "lastModified": "2021-10-07T15:48:44Z", "location": "https://instance-sevicenow/api/now/scim/Groups/a92b84f96b073010638c83eece44af4e" }, "displayName": "HR Team", "members": [ { "value": "62826bf03710200044e0bfc8bcbe5df1", "display": "Abel Tuter", "$ref": "https://instance-sevicenow/api/now/scim/Users/62826bf03710200044e0bfc8bcbe5df1" }, { "value": "a8f98bb0eb32010045e1a5115206fe3a", "display": "Abraham Lincoln", "$ref": "https://instance-sevicenow/api/now/scim/Users/a8f98bb0eb32010045e1a5115206fe3a" } ], "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group": { "company": { "value": "81fd65ecac1d55eb42a426568fc87a63", "name": "ACME Japan", "$ref": "http://instance-sevicenow/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63" } } } ## SCIM - POST /scim/Groupes {#ariaid-title6} Crée un enregistrement de groupe dans la table Groupe \[sys_user_group\] d'une ServiceNow instance à l'aide du protocole SCIM (System for Cross-domain Identity Management). Vous pouvez définir le nom d'affichage du groupe, un ID externe utilisé pour corréler ce groupe à un système externe, et ajouter des membres (utilisateurs/groupes) au groupe. Remarque : Les fonctionnalités de recherche et de modifications en bloc indiquées dans la spécification RFC7643 ne sont pas prises en charge par ce point de terminaison. ### Format d'URL URL versionnée : /api/now/{api_version}/scim/Groups URL par défaut : /api/now/scim/groups ### Paramètres de demande pris en charge {#scim-POST-Groups__entry__2}{#scim-POST-Groups__version-RESTAPI} | Nom | Description | |-|-| | api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne | [Tableau 37. Paramètres de chemin d'accès] {#scim-POST-Groups__entry__6}{#scim-POST-Groups__attributes-SCIM-entry}{#scim-POST-Groups__excludedAttributes-SCIM-entry} | Nom | Description | |-|-| | attributs | Liste des champs séparés par des virgules à envoyer dans la réponse. Aucun autre champ n'est renvoyé. Ne peut pas être utilisé avec le excludedAttributes paramètre. Type de données : chaîne Par défaut : renvoie tous les champs sauf s'il excludedAttributes est spécifié. | | Attributs exclus | Liste de champs séparés par des virgules à exclure des enregistrements renvoyés dans la réponse. Tous les autres champs sont renvoyés. Ne peut pas être utilisé avec le attributes paramètre. Type de données : chaîne Par défaut : n'excluez aucun champ. | [Tableau 38. Paramètres de requête] {#scim-POST-Groups__entry__12}{#scim-POST-Groups__group_company-SCIM-entry}{#scim-POST-Groups__group_company_display-SCIM-entry}{#scim-POST-Groups__group_company_ref-SCIM-entry}{#scim-POST-Groups__group_company_value-SCIM-entry}{#scim-POST-Groups__group_request_displayName-SCIM-entry}{#scim-POST-Groups__group_externalId-SCIM-entry}{#scim-POST-Groups__group_request_schema-SCIM-entry} | Nom | Description | |-|-| | company | Détails sur la société ou l'organisation du groupe. Type de données : objet "company": { "display": "String", "$ref": "String", "value": "String" } | | entreprise.display | Nom de la société. Type de données : chaîne | | entreprise.$ref | URI de référence de la société. Format : `/Entreprises/ de l'entreprise`, par exemple : `http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 `. Type de données : chaîne | | entreprise.valeur | Sys_id de la société associée. Type de données : chaîne | | displayName | Requis. Nom explicite du groupe, par exemple Équipe RH. Type de données : chaîne | | externalId | Identificateur unique affecté au groupe par l'entité qui le provisionne. Type de données : chaîne | | membres | Liste d'utilisateurs ou d'autres groupes à associer au groupe. Type de données : tableau d'objets "members:" [ { "value": "String" } ] Taille maximale : 100 : vous pouvez modifier cette taille maximale en mettant à jour la propriété système com.snc.interation.scim2.max.member.count. | | membres.valeur | Sys_id de l'enregistrement d'utilisateur ou de groupe associé. Type de données : chaîne | | Schémas | Requis. Liste des URI du groupe SCIM schémas utilisés pour traiter la demande. Schémas de groupe pris en charge : * urn :ietf :params :scim :schemas :core :2.0 :Group : schéma de base spécifié dans le système du groupe de travail d'ingénierie Internet pour la gestion des identités inter-domaines : document de schéma principal () * urn :ietf :params :scim :schemas :extension :servicenow :2.0 :Group : schéma d'extension ServiceNow . Ce schéma contient des attributs qui sont présents dans la table Groupes \[sys_user_group\] d'un système de base ServiceNow , mais qui ne font pas partie du schéma principal. * urn :ietf :params :scim :schemas :extension :servicenow :custom :2.0 :Group" : schéma d'extension personnalisé. Ce schéma fait partie de resourceType \<\< Groupe \>\> dans la table sys_scim_schema_extension. Si le schéma n'est pas actif, l'URN du schéma n'est pas renvoyé dans la réponse. {#scim-POST-Groups__ul_ckx_x3t_2tb} Type de données : tableau de chaînes | [Tableau 39. Paramètres du corps de la demande (JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-POST-Groups__entry__32}{#scim-POST-Groups__Accept-SCIM-entry}{#scim-POST-Groups__Content_Type-SCIM-entry} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/scim+json. Valeur par défaut : application/json | | Content-Type | Format de données du corps de la demande. Types pris en charge : application/json ou application/scim+json. Valeur par défaut : application/json | [Tableau 40. En-têtes de demandes] {#scim-POST-Groups__entry__38} | En-tête | Description | |-|-| | Aucun | | [Tableau 41. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-POST-Groups__entry__42}{#scim-POST-Groups__status_409-SCIM-entry}{#scim-POST-Groups__entry-500-status-code} | Code d'état | Description | |-|-| | 201 | Réussi. La demande a été correctement traitée. | | 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. * Vérifier les valeurs non valides : * Corps de demande mal formé. * Le champ obligatoire n'est pas fourni ou vide. * Un sys_id d'utilisateur ou de groupe non valide est fourni. * Vérifiez si un champ en lecture seule ou immuable essaie d'être modifié. * Assurez-vous que les paramètres de requête et excludedAttributes n'ont attributes pas été transmis dans la demande ou que la demande ne dépasse pas le nombre maximal de membres. {#scim-POST-Groups__status_400_extended-SCIM-entry} | | 409 | Le groupe existe déjà. Le displayName paramètre doit être unique. | | 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. | [Tableau 42. Codes d'état] ### Paramètres de corps de réponse (JSON) {#scim-POST-Groups__id_uwk_c5c_grb__entry__2}{#scim-POST-Groups__d2938e835}{#scim-POST-Groups__d2938e849}{#scim-POST-Groups__d2938e860}{#scim-POST-Groups__d2938e880}{#scim-POST-Groups__group_displayName-SCIM-entry}{#scim-POST-Groups__d2938e903}{#scim-POST-Groups__group_id-SCIM-entry}{#scim-POST-Groups__group_meta-SCIM-entry}{#scim-POST-Groups__group_meta_created-SCIM-entry}{#scim-POST-Groups__group_meta_lastModified-SCIM-entry}{#scim-POST-Groups__group_meta_location-SCIM-entry}{#scim-POST-Groups__group_meta_resourceType-SCIM-entry}{#scim-POST-Groups__group_members-SCIM-entry}{#scim-POST-Groups__group_members_display-SCIM-entry}{#scim-POST-Groups__group_members_value-SCIM-entry}{#scim-POST-Groups__group_members_ref-SCIM-entry}{#scim-POST-Groups__group_schemas-SCIM-entry} | Nom | Description | |-|-| | company | Détails sur la société ou l'organisation du groupe. Type de données : objet "company": { "display": "String", "$ref": "String", "value": "String" } | | entreprise.display | Nom de la société. Type de données : chaîne | | entreprise.$ref | URI de référence de la société. Format : `/Entreprises/ de l'entreprise`, par exemple : `http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 `. Type de données : chaîne | | entreprise.valeur | Sys_id de la société associée. Type de données : chaîne | | displayName | Nom explicite du groupe, par exemple Équipe RH. Type de données : chaîne | | externalId | Identificateur unique affecté au groupe par l'entité qui le provisionne. Type de données : chaîne | | id | Sys_id du groupe. Type de données : chaîne | | métadonnées | Métadonnées relatives au groupe. Type de données : objet "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" } | | meta.created | Date et heure de création de l'enregistrement de groupe. Type de données : chaîne | | meta.lastModified | Date et heure de la dernière modification de l'enregistrement de groupe. Type de données : chaîne | | meta.location | URI du groupe en cours de récupération. Type de données : chaîne | | meta.resourceType | Type de ressource des groupes SCIM. Type de données : chaîne | | membres | Liste des utilisateurs et des groupes associés au groupe. Type de données : tableau d'objets "members": [ { "display": "String", "value": "String", "$ref": "String" } ] | | membres.display | Nom du membre du groupe associé. Type de données : chaîne | | membres.valeur | Sys_id de l'enregistrement d'utilisateur ou de groupe associé. Type de données : chaîne | | membres.$ref | URI du membre de groupe associé. Type de données : chaîne | | Schémas | Liste des URI du groupe SCIM schémas utilisés pour traiter la demande. Schémas de groupe pris en charge : * urn :ietf :params :scim :schemas :core :2.0 :Group : schéma de base spécifié dans le système du groupe de travail d'ingénierie Internet pour la gestion des identités inter-domaines : document de schéma principal () * urn :ietf :params :scim :schemas :extension :servicenow :2.0 :Group : schéma d'extension ServiceNow . Ce schéma contient des attributs qui sont présents dans la table Groupes \[sys_user_group\] d'un système de base ServiceNow , mais qui ne font pas partie du schéma principal. * urn :ietf :params :scim :schemas :extension :servicenow :custom :2.0 :Group" : schéma d'extension personnalisé. Ce schéma fait partie de resourceType \<\< Groupe \>\> dans la table sys_scim_schema_extension. Si le schéma n'est pas actif, l'URN du schéma n'est pas renvoyé dans la réponse. {#scim-POST-Groups__d2938e1035} Type de données : tableau de chaînes | [ ] {#scim-POST-Groups__id_uwk_c5c_grb} ### demande cURL PUBLIER un nouveau groupe et ajouter un membre Cet exemple crée group51 et ajoute l'utilisateur Abel Tutor en tant que membre. curl "https://instance-servicenow.com/api/now/scim/Groups" \ --request POST \ --header "Accept:application/scim+json" \ --header "Content-Type:application/scim+json" \ --data "{ \"schemas\": ["urn:ietf:params:scim:schemas:core:2.0:Group", "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group", "urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group"], \"displayName\": \"HR Team\", \"externalId\": \"8ae5dc9e-c7ad-4d3d-a152-35a6b6222b83\", \"members\": [ { \"value\": \"62826bf03710200044e0bfc8bcbe5df1\", \"$ref\": \"Users/62826bf03710200044e0bfc8bcbe5df1\" } ] }" Réponse : {"schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group", "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group", 'urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group' ], "id":"e0140d671bbe3010593876a61a4bcb11", "externalId":"8ae5dc9e-c7ad-4d3d-a152-35a6b6222b83", "meta":{ "resourceType":"Group", "created":"2021-09-30T18:20:43Z", "lastModified":"2021-09-30T18:20:43Z", "location":"https://instance-servicenow.com/api/now/scim/Groups/e0140d671bbe3010593876a61a4bcb11"}, "displayName":"HR Team", "members":[ { "value":"62826bf03710200044e0bfc8bcbe5df1", "display":"Abel Tuter", "$ref": "http://instance-servicenow.com/api/now/scim/Users/62826bf03710200044e0bfc8bcbe5df1" } ], "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group": { "company": { "value": "81fd65ecac1d55eb42a426568fc87a63", "name": "ACME Japan", "$ref": http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 } } } } ## SCIM - PUT /scim/Groups/{group_id} {#ariaid-title7} Met à jour l'enregistrement de groupe spécifié dans la table Groupe \[sys_user_group\] d'une ServiceNow instance utilisant le protocole SCIM (System for Cross-domain Identity Management). Les champs omis dans la demande ne sont pas mis à jour. Vous pouvez effacer explicitement un champ en définissant sa valeur sur null pour un champ à valeur unique et sur un tableau vide pour les champs de type tableau tels que members. ### Format d'URL URL versionnée : /api/now/{api_version}/scim/groups/{group_id} URL par défaut : /api/now/scim/groups/{group_id} ### Paramètres de demande pris en charge {#scim-PUT-Groups-group_id__entry__2}{#scim-PUT-Groups-group_id__version-RESTAPI} | Nom | Description | |-|-| | api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne | | group_id | Sys_id de l'enregistrement de groupe à mettre à jour. | [Tableau 43. Paramètres de chemin d'accès] {#scim-PUT-Groups-group_id__entry__8}{#scim-PUT-Groups-group_id__attributes-SCIM-entry}{#scim-PUT-Groups-group_id__excludedAttributes-SCIM-entry} | Nom | Description | |-|-| | attributs | Liste des champs séparés par des virgules à envoyer dans la réponse. Aucun autre champ n'est renvoyé. Ne peut pas être utilisé avec le excludedAttributes paramètre. Type de données : chaîne Par défaut : renvoie tous les champs sauf s'il excludedAttributes est spécifié. | | Attributs exclus | Liste de champs séparés par des virgules à exclure des enregistrements renvoyés dans la réponse. Tous les autres champs sont renvoyés. Ne peut pas être utilisé avec le attributes paramètre. Type de données : chaîne Par défaut : n'excluez aucun champ. | [Tableau 44. Paramètres de requête] {#scim-PUT-Groups-group_id__entry__14}{#scim-PUT-Groups-group_id__group_company-SCIM-entry}{#scim-PUT-Groups-group_id__group_company_display-SCIM-entry}{#scim-PUT-Groups-group_id__group_company_ref-SCIM-entry}{#scim-PUT-Groups-group_id__group_company_value-SCIM-entry}{#scim-PUT-Groups-group_id__group_displayName-SCIM-entry}{#scim-PUT-Groups-group_id__group_externalId-SCIM-entry}{#scim-PUT-Groups-group_id__group_request_schema-SCIM-entry} | Nom | Description | |-|-| | company | Détails sur la société ou l'organisation du groupe. Type de données : objet "company": { "display": "String", "$ref": "String", "value": "String" } | | entreprise.display | Nom de la société. Type de données : chaîne | | entreprise.$ref | URI de référence de la société. Format : `/Entreprises/ de l'entreprise`, par exemple : `http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 `. Type de données : chaîne | | entreprise.valeur | Sys_id de la société associée. Type de données : chaîne | | displayName | Nom explicite du groupe, par exemple Équipe RH. Type de données : chaîne | | externalId | Identificateur unique affecté au groupe par l'entité qui le provisionne. Type de données : chaîne | | membres | Liste des utilisateurs par lesquels remplacer la liste actuelle des membres. Type de données : tableau d'objets "members:" [ { "value": "String" } ] Taille maximale : 100 : vous pouvez modifier cette taille maximale en mettant à jour la propriété système com.snc.interation.scim2.max.member.count. | | membres.valeur | Sys_id de l'enregistrement d'utilisateur ou de groupe associé. Type de données : chaîne | | Schémas | Requis. Liste des URI du groupe SCIM schémas utilisés pour traiter la demande. Schémas de groupe pris en charge : * urn :ietf :params :scim :schemas :core :2.0 :Group : schéma de base spécifié dans le système du groupe de travail d'ingénierie Internet pour la gestion des identités inter-domaines : document de schéma principal () * urn :ietf :params :scim :schemas :extension :servicenow :2.0 :Group : schéma d'extension ServiceNow . Ce schéma contient des attributs qui sont présents dans la table Groupes \[sys_user_group\] d'un système de base ServiceNow , mais qui ne font pas partie du schéma principal. * urn :ietf :params :scim :schemas :extension :servicenow :custom :2.0 :Group" : schéma d'extension personnalisé. Ce schéma fait partie de resourceType \<\< Groupe \>\> dans la table sys_scim_schema_extension. Si le schéma n'est pas actif, l'URN du schéma n'est pas renvoyé dans la réponse. {#scim-PUT-Groups-group_id__ul_ckx_x3t_2tb} Type de données : tableau de chaînes | [Tableau 45. Paramètres du corps de la demande (JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-PUT-Groups-group_id__entry__34}{#scim-PUT-Groups-group_id__Accept-SCIM-entry}{#scim-PUT-Groups-group_id__Content_Type-SCIM-entry} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/scim+json. Valeur par défaut : application/json | | Content-Type | Format de données du corps de la demande. Types pris en charge : application/json ou application/scim+json. Valeur par défaut : application/json | [Tableau 46. En-têtes de demandes] {#scim-PUT-Groups-group_id__entry__40} | En-tête | Description | |-|-| | Aucun | | [Tableau 47. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-PUT-Groups-group_id__entry__44}{#scim-PUT-Groups-group_id__entry-200-status-code}{#scim-PUT-Groups-group_id__entry-404-status-code}{#scim-PUT-Groups-group_id__status_409-SCIM-entry}{#scim-PUT-Groups-group_id__entry-500-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. * Vérifier les valeurs non valides : * Corps de demande mal formé. * Le champ obligatoire n'est pas fourni ou vide. * Un sys_id d'utilisateur ou de groupe non valide est fourni. * Vérifiez si un champ en lecture seule ou immuable essaie d'être modifié. * Assurez-vous que les paramètres de requête et excludedAttributes n'ont attributes pas été transmis dans la demande ou que la demande ne dépasse pas le nombre maximal de membres. {#scim-PUT-Groups-group_id__status_400_extended-SCIM-entry} | | 404 | Introuvable. L'élément demandé est introuvable. | | 409 | Le groupe existe déjà. Le displayName paramètre doit être unique. | | 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. | [Tableau 48. Codes d'état] ### Paramètres de corps de réponse (JSON) {#scim-PUT-Groups-group_id__entry__56}{#scim-PUT-Groups-group_id__d2938e835}{#scim-PUT-Groups-group_id__d2938e849}{#scim-PUT-Groups-group_id__d2938e860}{#scim-PUT-Groups-group_id__d2938e880}{#scim-PUT-Groups-group_id__d2938e891}{#scim-PUT-Groups-group_id__errors-SCIM-entry}{#scim-PUT-Groups-group_id__errors_details-SCIM-entry}{#scim-PUT-Groups-group_id__errors_scimType-SCIM-entry}{#scim-PUT-Groups-group_id__errors_schemas-SCIM-entry}{#scim-PUT-Groups-group_id__errors_status-SCIM-entry}{#scim-PUT-Groups-group_id__d2938e903}{#scim-PUT-Groups-group_id__group_id-SCIM-entry}{#scim-PUT-Groups-group_id__group_members-SCIM-entry}{#scim-PUT-Groups-group_id__group_members_display-SCIM-entry}{#scim-PUT-Groups-group_id__group_members_value-SCIM-entry}{#scim-PUT-Groups-group_id__group_members_ref-SCIM-entry}{#scim-PUT-Groups-group_id__group_meta-SCIM-entry}{#scim-PUT-Groups-group_id__group_meta_created-SCIM-entry}{#scim-PUT-Groups-group_id__group_meta_lastModified-SCIM-entry}{#scim-PUT-Groups-group_id__group_meta_location-SCIM-entry}{#scim-PUT-Groups-group_id__group_meta_resourceType-SCIM-entry}{#scim-PUT-Groups-group_id__group_schemas-SCIM-entry} | Nom | Description | |-|-| | company | Détails sur la société ou l'organisation du groupe. Type de données : objet "company": { "display": "String", "$ref": "String", "value": "String" } | | entreprise.display | Nom de la société. Type de données : chaîne | | entreprise.$ref | URI de référence de la société. Format : `/Entreprises/ de l'entreprise`, par exemple : `http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 `. Type de données : chaîne | | entreprise.valeur | Sys_id de la société associée. Type de données : chaîne | | displayName | Nom explicite du groupe, par exemple Équipe RH. Type de données : chaîne | | erreurs | Réponse décrivant toute erreur qui a pu se produire pendant le traitement de la demande. Type de données : objet "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" } | | errors.detail | Message d'erreur détaillé expliquant pourquoi la demande a échoué. Type de données : chaîne | | errors.scimType | Mot clé de détail de l'erreur SCIM. Type de données : chaîne | | Schémas.erreurs | URI des schémas SCIM utilisés pour traiter la réponse d'erreur. Type de données : tableau de chaînes | | erreurs.état | Code d'état HTTP de la réponse d'erreur. Type de données : chaîne | | externalId | Identificateur unique affecté au groupe par l'entité qui le provisionne. Type de données : chaîne | | id | Sys_id du groupe. Type de données : chaîne | | membres | Liste des utilisateurs et des groupes associés au groupe. Type de données : tableau d'objets "members": [ { "display": "String", "value": "String", "$ref": "String" } ] | | membres.display | Nom du membre du groupe associé. Type de données : chaîne | | membres.valeur | Sys_id de l'enregistrement d'utilisateur ou de groupe associé. Type de données : chaîne | | membres.$ref | URI du membre de groupe associé. Type de données : chaîne | | métadonnées | Métadonnées relatives au groupe. Type de données : objet "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" } | | meta.created | Date et heure de création de l'enregistrement de groupe. Type de données : chaîne | | meta.lastModified | Date et heure de la dernière modification de l'enregistrement de groupe. Type de données : chaîne | | meta.location | URI du groupe en cours de récupération. Type de données : chaîne | | meta.resourceType | Type de ressource des groupes SCIM. Type de données : chaîne | | Schémas | Liste des URI du groupe SCIM schémas utilisés pour traiter la demande. Schémas de groupe pris en charge : * urn :ietf :params :scim :schemas :core :2.0 :Group : schéma de base spécifié dans le système du groupe de travail d'ingénierie Internet pour la gestion des identités inter-domaines : document de schéma principal () * urn :ietf :params :scim :schemas :extension :servicenow :2.0 :Group : schéma d'extension ServiceNow . Ce schéma contient des attributs qui sont présents dans la table Groupes \[sys_user_group\] d'un système de base ServiceNow , mais qui ne font pas partie du schéma principal. * urn :ietf :params :scim :schemas :extension :servicenow :custom :2.0 :Group" : schéma d'extension personnalisé. Ce schéma fait partie de resourceType \<\< Groupe \>\> dans la table sys_scim_schema_extension. Si le schéma n'est pas actif, l'URN du schéma n'est pas renvoyé dans la réponse. {#scim-PUT-Groups-group_id__d2938e1035} Type de données : tableau de chaînes | [ ] ### Demande cURL mettant à jour les membres du groupe à l'aide de PUT L'exemple suivant remplace le membre associé au groupe par Abraham Lincoln au lieu d'Abel Tutor et le nom du groupe par Équipe RH. curl "https://instance-servicenow.com/api/now/scim/Groups/e0140d671bbe3010593876a61a4bcb11" \ --request PUT \ --header "Accept:application/scim+json" \ --header "Content-Type:application/scim+json" \ --data "{ \"schemas\": ["urn:ietf:params:scim:schemas:core:2.0:Group", "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group", "urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group"], \"displayName\": \"HR Team\", \"externalId\": \"8ae5dc9e-c7ad-4d3d-a152-35a6b6222b83\", \"members\": [ { \"value\": \"a8f98bb0eb32010045e1a5115206fe3a\", \"$ref\": \"Users\" } ] }" Réponse : {"schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group", "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group", 'urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group' ], "id":"e0140d671bbe3010593876a61a4bcb11", "externalId":"8ae5dc9e-c7ad-4d3d-a152-35a6b6222b83", "meta":{ "resourceType":"Group", "created":"2021-09-30T18:20:43Z", "lastModified":"2021-09-30T21:19:40Z", "location":"https://instance-servicenow.com/api/now/scim/Groups/e0140d671bbe3010593876a61a4bcb11" }, "displayName":"HR Team", "members":[ { "value":"a8f98bb0eb32010045e1a5115206fe3a", "display":"Abraham Lincoln", "$ref": "http://instance-servicenow.com/api/now/scim/Users/62826bf03710200044e0bfc8bcbe5df1" } ], "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group": { "company": { "value": "81fd65ecac1d55eb42a426568fc87a63", "name": "ACME Japan", "$ref": "http://192.168.1.25:8080/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63" } } } ## SCIM - DELETE /scim/Users/{user_id} {#ariaid-title8} Supprime l'enregistrement utilisateur spécifié de la table Utilisateur \[sys_user\] d'une ServiceNow instance utilisant le protocole SCIM (System for Cross-domain Identity Management). ### Format d'URL URL versionnée : /api/now/{api_version}/scim/Users/{user_id} URL par défaut : /api/now/scim/Users/{user_id} ### Paramètres de demande pris en charge {#scim-DELETE-Users-user_id__entry__2}{#scim-DELETE-Users-user_id__version-RESTAPI} | Nom | Description | |-|-| | api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne | | user_id | Sys_id de l'enregistrement utilisateur à supprimer. | [Tableau 49. Paramètres de chemin d'accès] {#scim-DELETE-Users-user_id__entry__8} | Nom | Description | |-|-| | Aucun | | [Tableau 50. Paramètres de requête] {#scim-DELETE-Users-user_id__entry__12} | Nom | Description | |-|-| | Aucun | | [Tableau 51. Paramètres du corps de la demande (JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-DELETE-Users-user_id__entry__16}{#scim-DELETE-Users-user_id__Accept-SCIM-entry} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/scim+json. Valeur par défaut : application/json | [Tableau 52. En-têtes de demandes] {#scim-DELETE-Users-user_id__entry__20} | En-tête | Description | |-|-| | Aucun | | [Tableau 53. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-DELETE-Users-user_id__entry__24}{#scim-DELETE-Users-user_id__entry-200-status-code}{#scim-DELETE-Users-user_id__entry-404-status-code} | Code d'état | Description | |-|-| | 204 | Aucun contenu. La demande a été correctement traitée. | | 404 | Introuvable. L'élément demandé est introuvable. | [Tableau 54. Codes d'état] ### Paramètres de corps de réponse (JSON) {#scim-DELETE-Users-user_id__entry__30}{#scim-DELETE-Users-user_id__errors-SCIM-entry}{#scim-DELETE-Users-user_id__errors_details-SCIM-entry}{#scim-DELETE-Users-user_id__errors_scimType-SCIM-entry}{#scim-DELETE-Users-user_id__errors_schemas-SCIM-entry}{#scim-DELETE-Users-user_id__errors_status-SCIM-entry} | Nom | Description | |-|-| | erreurs | Réponse décrivant toute erreur qui a pu se produire pendant le traitement de la demande. Type de données : objet "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" } | | errors.detail | Message d'erreur détaillé expliquant pourquoi la demande a échoué. Type de données : chaîne | | errors.scimType | Mot clé de détail de l'erreur SCIM. Type de données : chaîne | | Schémas.erreurs | URI des schémas SCIM utilisés pour traiter la réponse d'erreur. Type de données : tableau de chaînes | | erreurs.état | Code d'état HTTP de la réponse d'erreur. Type de données : chaîne | [ ] ### Demande cURL Cet exemple montre comment supprimer un enregistrement utilisateur de la table Utilisateur \[sys_user\]. curl "https://instance-servicenow.com/api/now/scim/Users/b7c5015f778330102e8cc5179e5a9992" \ --request DELETE \ --header "Accept:application/scim+json" \ ## SCIM : GET /scim/Users {#ariaid-title9} Renvoie un ou plusieurs enregistrements utilisateur de la table Utilisateur \[sys_user\] au sein d'une ServiceNow instance utilisant le protocole SCIM (System for Cross-domain Identity Management). Remarque : Une requête qui ne renvoie aucune correspondance renvoie un message de réussite (code d'état HTTP 200) avec totalResults la valeur 0. ### Format d'URL URL versionnée : /api/now/{api_version}/scim/Users URL par défaut : /api/now/scim/Users ### Paramètres de demande pris en charge {#scim-GET-Users__entry__2}{#scim-GET-Users__version-RESTAPI} | Nom | Description | |-|-| | api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne | [Tableau 55. Paramètres de chemin d'accès] {#scim-GET-Users__entry__6}{#scim-GET-Users__attributes-SCIM-entry}{#scim-GET-Users__count-SCIM-entry}{#scim-GET-Users__excludedAttributes-SCIM-entry}{#scim-GET-Users__user_filter-SCIM-entry}{#scim-GET-Users__user_sortBy-SCIM-entry}{#scim-GET-Users__sortOrder-SCIM-entry}{#scim-GET-Users__user_startIndex-SCIM-entry} | Nom | Description | |-|-| | attributs | Liste des champs séparés par des virgules à envoyer dans la réponse. Aucun autre champ n'est renvoyé. Ne peut pas être utilisé avec le excludedAttributes paramètre. Type de données : chaîne Par défaut : renvoie tous les champs sauf s'il excludedAttributes est spécifié. | | compter | Nombre d'enregistrements à renvoyer. Une valeur négative est interprétée comme zéro. Type de données : nombre Maximum : 500 : une valeur supérieure à cette valeur entraîne une erreur de demande incorrecte. Par défaut : 10 | | Attributs exclus | Liste de champs séparés par des virgules à exclure des enregistrements renvoyés dans la réponse. Tous les autres champs sont renvoyés. Ne peut pas être utilisé avec le attributes paramètre. Type de données : chaîne Par défaut : n'excluez aucun champ. | | filtre | Expression de filtre à appliquer aux résultats renvoyés. Les filtres de champ sont exprimés sous la forme ` <"valeur>`. Consultez [RFC7644](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2) pour obtenir la liste des opérateurs valides. Remarque : L'opérateur `NOT` n'est pas pris en charge. Par exemple, pour filtrer tous les utilisateurs dont le nom commence par \<\< Jo \>\>, saisissez `userName SW << jo >>` (insensible à la casse). Pour spécifier plusieurs filtres de champ, concaténez les filtres à l'aide de l'opérande `ET` . Par exemple, pour filtrer tous les utilisateurs dont le nom commence par \<\< Jo \>\> et dont le nom de famille contient \<\< smi \>\>, saisissez `userName SW << john >> ET name.familyName CO << smi >>.` Utilisez la remontée pas à pas pour spécifier les attributs imbriqués. Seuls les champs utilisateur SCIM suivants peuvent être utilisés dans les filtres et certains, comme indiqué, ne prennent en charge que le format fixe : * Actif * adresses : format fixe uniquement, tel que : * \[type eq \<\< home \>\> et streetAddress eq \<\< xxxx"\] * \[type eq \<\< home \>\> et locality eq \<\< xxxx"\] * \[Tapez l'égaliseur \<\< home \>\> et l'égaliseur régional \<\< XXXX"\] * \[type eq \<\< home \>\> et postalCode eq \<\< xxxx"\] * \[Tapez l'égaliseur \<\< home \>\> et l'égaliseur pays \<\< XXXX"\] {#scim-GET-Users__ul_img_kgm_hrb} * displayName * e-mails - Format fixe uniquement, tel que : \[type eq \<\< work \>\> et value eq \<\< emailValue"\] * externalId : seul l'opérateur `d'égalisation` est pris en charge. * id * meta.created * meta.lastModified * nom.nom.nom de famille * nom.nomdonné * nom.deuxième prénom * preferredLanguage * phoneNumbers : format fixe uniquement, tel que : * \[Tapez l'égaliseur \<\< travail \>\> et l'égaliseur de valeur \<\< XXXX"\] * \[Tapez l'égaliseur \<\< mobile \>\> et l'égaliseur de valeur \<\< XXXX"\] * \[Tapez l'égaliseur \<\< home \>\> et l'égaliseur de valeur \<\< XXXX"\] {#scim-GET-Users__ul_yg1_cgm_hrb} * fuseau horaire * Titre * userName * urn :ietf :params :scim :schemas :extension :servicenow :2.0 :User :employeeNumber * urn :ietf :params :scim :schemas :extension :servicenow :2.0 :User :gender * urn :ietf :params :scim :schemas :extension :servicenow :2.0 :User :department.name * urn :ietf :params :scim :schemas :extension :servicenow :2.0 :User :department.value * urn :ietf :params :scim :schemas :extension :servicenow :2.0 :User :manager.displayName * urn :ietf :params :scim :schemas :extension :servicenow :2.0 :User :manager.value * urn :ietf :params :scim :schemas :extension :servicenow :2.0 :User :costCenter.name * urn :ietf :params :scim :schemas :extension :servicenow :2.0 :User :costCenter.value * urn :ietf :params :scim :schemas :extension :servicenow :2.0 :User :company.name * urn :ietf :params :scim :schemas :extension :servicenow :2.0 :User :company.value * urn :ietf :params :scim :schemas :extension :servicenow :2.0 :User :location.name * urn :ietf :params :scim :schemas :extension :servicenow :2.0 :User :location.value {#scim-GET-Users__ul_w3k_bcc_grb} Type de données : chaîne Par défaut : aucun filtrage | | trier par | Doit être spécifié avec le sortOrder paramètre. Champ utilisé pour trier les résultats renvoyés. Le tri n'est pas sensible à la casse. Vous ne pouvez utiliser que les paramètres disponibles pour le filtrage du sortBy paramètre, à l'exception de , qui n'est externalIdpas autorisé. De plus, seuls les paramètres de remontée pas à pas suivants sont pris en charge : * addressess - Seules les valeurs suivantes sont autorisées : * addresses.streetAddress - Mappe l'adresse postale du domicile. * addresses.home.streetAddress * addresses.locality - Cartes de la localité d'origine. * addresses.home.locality * addresses.region - Cartes de la région d'origine. * addresses.home.region * addresses.postalCode - Mappe le code postal du domicile. * addresses.home.postalCode * addresses.country - Cartes du pays d'origine. * addresses.home.country {#scim-GET-Users__ul_g32_5lm_hrb} * emails - Seules les valeurs suivantes sont autorisées : * emails.value - Correspond au travail de type e-mail. * emails.work.value {#scim-GET-Users__ul_dnq_wjm_hrb} * phoneNumbers - Seules les valeurs suivantes sont autorisées : * phoneNumbers.value - Mappe au travail de type numéro de téléphone. * phoneNumbers.home.value * phoneNumbers.mobile.value * phoneNumbers.work.value {#scim-GET-Users__ul_gtf_fkm_hrb} {#scim-GET-Users__ul_emm_33m_hrb} Pour les valeurs nulles : * Trié par ordre croissant : les valeurs nulles sont triées tout en haut. * trié par ordre décroissant : les valeurs nulles sont triées en bas. {#scim-GET-Users__ul_ts1_lhm_hrb} Type de données : chaîne Par défaut : aucun tri effectué | | sortOrder | Doit être spécifié avec le sortBy paramètre. Ordre dans lequel le sortBy paramètre est appliqué aux résultats renvoyés. Valeurs valides : * ascendant * descendant {#scim-GET-Users__ul_mmn_zrc_grb} Type de données : chaîne Par défaut : croissant | | startIndex | Index de base unique dans la table Utilisateur \[sys_user\] à partir de laquelle commencer à récupérer des enregistrements. Par exemple, si vous définissez ce paramètre sur 100 et le count paramètre sur 20, le point de terminaison renvoie les enregistrements 100 à 119. Remarque : Toute valeur qui est définie sur moins de un est interprétée comme un. Non valide avec le paramètre path id . Type de données : chaîne Valeur par défaut : 1 | [Tableau 56. Paramètres de requête] {#scim-GET-Users__entry__22} | Nom | Description | |-|-| | Aucun | | [Tableau 57. Paramètres de corps de demande (XML ou JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-GET-Users__entry__26}{#scim-GET-Users__Accept-SCIM-entry} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/scim+json. Valeur par défaut : application/json | [Tableau 58. En-têtes de demandes] {#scim-GET-Users__entry__30} | En-tête | Description | |-|-| | Aucun | | [Tableau 59. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-GET-Users__entry__34}{#scim-GET-Users__entry-200-status-code}{#scim-GET-Users__status_400-SCIM-entry} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. * Assurez-vous que les paramètres de requête et excludedAttributes n'ont attributes pas été transmis dans la demande. * Assurez-vous que le paramètre n'est count pas supérieur à 500. * Assurez-vous que tous les filter paramètres sont valides. {#scim-GET-Users__ul_vn1_gvz_nrb} | [Tableau 60. Codes d'état] ### Paramètres de corps de réponse (JSON) {#scim-GET-Users__entry__40}{#scim-GET-Users__itemsPerPage-SCIM-entry}{#scim-GET-Users__user_userName-SCIM-ph}{#scim-GET-Users__user_schemas-SCIM-entry}{#scim-GET-Users__totalResults-SCIM-entry} | Nom | Description | |-|-| | itemsPerPage | Nombre d'enregistrements renvoyés dans les résultats renvoyés. Type de données : nombre | | Ressources | Liste des enregistrements d'utilisateurs. Type de données : tableau d'objets "Resources": [ { "active": Boolean, "addresses": {Object}, "displayName": "String", "emails": [Array], "externalId": "String", "groups": [Array], "id": "String", "meta": {Object}, "name": {Object}, "phoneNumbers": [Array], "preferredLanguage": "String", "schemas": [Array], "timezone": "String", "title": "String", "userName": "String", "userType": "String" } ] | | Ressources.actives | Marqueur indiquant si l'utilisateur associé est actif au sein de l'instance ServiceNow . Valeurs possibles : * true : l'utilisateur est actif. * false : l'utilisateur est inactif. {#scim-GET-Users__ul_glm_qkj_grb} Type de données : booléennes | | Resources.adresses | Détails de l'adresse postale actuelle de l'utilisateur. Type de données : objet "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" } | | Resources.addresses.country | Nom du pays. Type de données : chaîne | | Ressources.adresses.localité | Nom de la ville ou de la localité. Type de données : chaîne | | Ressources.adresses.codepostal | Code postal. Type de données : chaîne | | Ressources.adresses.région | État ou région. Type de données : chaîne | | Ressources.adresses.adresses_rue | Adresse postale complète. Il peut s'agir du numéro de maison, du nom de la rue, de la boîte postale et de l'adresse postale étendue sur plusieurs lignes. Type de données : chaîne | | Ressources.adresses.type | Type d'adresse. Ne prend actuellement en charge que la page d'accueil. Type de données : chaîne | | Resources.displayName | Nom d'affichage de l'utilisateur. Cette valeur est générée automatiquement par concaténation des name champs. Type de données : chaîne | | Ressources.e-mails | Liste des comptes de messagerie associés à l'utilisateur. Type de données : tableau d'objets "emails:" [ { "type": "String", "value": "String" } ] | | Ressources.emails.type | Type d'e-mail de l'utilisateur. Ne prend actuellement en charge que le type de \<\< travail \>\>. Type de données : chaîne | | Ressources.emails.valeur | Adresse e-mail de l'utilisateur. Il s'agit d'une clé unique pour l'utilisateur associé. Type de données : chaîne | | Resources.externalId | Identificateur unique affecté à l'utilisateur par l'entité qui le provisionne. Type de données : chaîne | | Ressources.groupes | Liste des groupes auxquels l'utilisateur appartient, soit par adhésion directe, soit par groupes imbriqués, soit calculée dynamiquement. Type de données : tableau d'objets "groups": [ { "display": "String", "type": "String", "value": "String", "$ref": "String" } ] | | Ressources.groupes.display | Nom du groupe associé. Type de données : chaîne | | Ressources.groupes.type | Type d'association de groupe, directe ou indirecte, par exemple. Type de données : chaîne | | Ressources.groupes.valeur | Sys_id d'un enregistrement de groupe associé. Type de données : chaîne | | Ressources.groupes.ref | URI du groupe associé. Type de données : chaîne | | Resources.id | Sys_id de l'enregistrement utilisateur associé. Type de données : chaîne | | Ressources.meta | Métadonnées relatives à l'utilisateur. Type de données : objet "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" } | | Ressources.meta.créé | Date et heure de création de l'enregistrement utilisateur. Type de données : chaîne | | Ressources.meta.lastModified | Date et heure auxquelles l'enregistrement utilisateur a été modifié pour la dernière fois. Type de données : chaîne | | Ressources.meta.location | L'URI de l'utilisateur en cours de récupération. Type de données : chaîne | | Resources.meta.resourceType | Type de ressource des utilisateurs SCIM. Type de données : chaîne | | Resources.name | Informations sur le nom de l'utilisateur. Type de données : objet "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" } | | Resources.name.familyName | Nom de famille ou nom de famille de l'utilisateur. Type de données : chaîne | | Resources.name.givenName | Prénom de l'utilisateur. Type de données : chaîne | | Resources.name.honorificPrefix | Nom ou titre honorifique de l'utilisateur, tel que Dr., Bishop ou Baron. Type de données : chaîne | | Ressources.nom.middle | Deuxième prénom de l'utilisateur. Type de données : chaîne | | Ressources.Numéros de téléphone | Liste des numéros de téléphone associés à l'utilisateur. Type de données : tableau d'objets "phoneNumbers": [ { "type": "String", "value": "String" } ] | | Ressources.NuméroTéléphone.Type | Type de numéro de téléphone. Valeurs possibles : * accueil * mobile * travail {#scim-GET-Users__ul_idb_brj_grb} Type de données : chaîne | | Ressources.NuméroTéléphone.valeur | Numéro de téléphone de l'utilisateur. Type de données : chaîne | | Ressources.PreferredLanguage | Langue parlée et écrite préférée de l'utilisateur. Type de données : chaîne | | Resources.schemas | Liste des URI des schémas d'utilisateur SCIM utilisés pour traiter la demande. Type de données : tableau de chaînes | | Resources.timezone | Fuseau horaire de l'utilisateur. Type de données : chaîne | | Ressources.titre | Titre de l'utilisateur, par exemple PDG ou Président. Type de données : chaîne | | Resources.userName | Nom d'utilisateur unique pour l'utilisateur associé. Type de données : chaîne | | Ressources.userType | Type d'utilisateur. Cette valeur est utilisée pour identifier la relation entre l'organisation et l'utilisateur. Il peut s'agir de n'importe quelle valeur, mais les valeurs typiques peuvent inclure : * Prestataire * Employé * Interne * Intérimaire * Externe * Inconnu {#scim-GET-Users__ul_kdr_nwz_nrb} Type de données : chaîne | | Schémas | Liste des URI des schémas SCIM ListResponse utilisés pour traiter la demande. Type de données : tableau de chaînes | | startIndex | Index de base un dans la table Utilisateur \[sys_user\] dans laquelle les enregistrements ont été renvoyés. Type de données : chaîne | | totalResults | Nombre total d'enregistrements qui correspondent à la demande. Type de données : nombre | [ ] ### Paramètres d'extension retournés {#scim-GET-Users__section_vb2_yny_jlb} {#scim-GET-Users__id_hmw_fjk_grb__entry__2}{#scim-GET-Users__user_company-SCIM-entry}{#scim-GET-Users__user_company_display-SCIM-entry}{#scim-GET-Users__user_company_value-SCIM-ph}{#scim-GET-Users__user_company_ref-SCIM-entry}{#scim-GET-Users__user_costCenter-SCIM-entry}{#scim-GET-Users__user_costCenter_display-SCIM-entry}{#scim-GET-Users__user_costCenter_value-SCIM-ph}{#scim-GET-Users__user_costCenter_ref-SCIM-entry}{#scim-GET-Users__user_department-SCIM-entry}{#scim-GET-Users__user_department_display-SCIM-entry}{#scim-GET-Users__user_department_value-SCIM-ph}{#scim-GET-Users__user_department_ref-SCIM-entry}{#scim-GET-Users__user_employeeNumber-SCIM-entry}{#scim-GET-Users__user_gender-SCIM-entry}{#scim-GET-Users__user_location-SCIM-entry}{#scim-GET-Users__user_location_display-SCIM-entry}{#scim-GET-Users__user_location_value-SCIM-ph}{#scim-GET-Users__user_location_ref-SCIM-entry}{#scim-GET-Users__user_manager-SCIM-entry}{#scim-GET-Users__user_manager_display-SCIM-entry}{#scim-GET-Users__user_manager_value-SCIM-ph}{#scim-GET-Users__user_manager_ref-SCIM-entry} | Nom | Description | |-|-| | company | Détails sur la société associée à l'utilisateur. Type de données : objet "company": { "display": "String", "value": "String", "$ref": "String" } | | entreprise.display | Nom de la société. Type de données : chaîne | | entreprise.valeur | Sys_id de l'enregistrement de société. Type de données : chaîne | | entreprise.$ref | URI de référence pour la société. Type de données : chaîne | | Centre de coûts | Détails sur le centre de coûts associé à l'utilisateur. Type de données : objet "costCenter": { "display": "String", "value": "String", "$ref": "String" } | | centredecoûts.affichage | Nom du centre de coûts. Type de données : chaîne | | centre-coûts.valeur | Sys_id de l'enregistrement de centre de coûts. Type de données : chaîne | | centredecoûts.$ref | URI de référence pour le centre de coûts. Type de données : chaîne | | département | Détails sur le département associé à l'utilisateur. Type de données : objet "department": { "display": "String", "value": "String", "$ref": "String" } | | department.display | Nom du département. Type de données : chaîne | | valeur.département | Sys_id de l'enregistrement du département. Type de données : chaîne | | département.$ref | URI de référence pour le département. Type de données : chaîne | | employeeNumber | Numéro d'employé numérique ou alphanumérique. Type de données : chaîne | | sexe | Sexe de l'utilisateur, par exemple homme ou femme. Type de données : chaîne | | emplacement | Détails sur l'emplacement associé de l'utilisateur. Type de données : objet "location": { "display": "String", "value": "String", "$ref": "String" } | | Emplacement.Affichage | Nom de l'emplacement. Type de données : chaîne | | Emplacement.valeur | Sys_id de l'enregistrement de l'emplacement. Type de données : chaîne | | l'emplacement.$ref | URI de référence pour l'emplacement. Type de données : chaîne | | responsable | Détails sur le gestionnaire associé à l'utilisateur. Type de données : objet "manager": { "display": "String", "value": "String", "$ref": "String" } | | manager.display | Nom du gestionnaire. Type de données : chaîne | | gestionnaire.valeur | Sys_id de l'enregistrement du gestionnaire. Type de données : chaîne | | gestionnaire.$ref | URI de référence pour le gestionnaire. Type de données : chaîne | [ ] {#scim-GET-Users__id_hmw_fjk_grb} ### Demande cURL utilisant des attributs {#scim-GET-Users__example_kkl_rjj_grb} L'exemple suivant montre comment obtenir deux utilisateurs à partir du sixième enregistrement et ne renvoyer que le nom d'affichage. curl "https://instance-servicenow.com/api/now/scim/Users?attributes=displayName&startIndex=6&count=2" \ --request GET \ --header "Accept:application/scim+json" \ Réponse : {"schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"], "totalResults":619, "Resources": [ { "schemas": [ "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User", "urn:ietf:params:scim:schemas:core:2.0:User" ], "id":"02826bf03710200044e0bfc8bcbe5d6d", "displayName":"Sean Bonnet" }, { "schemas": [ "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User", "urn:ietf:params:scim:schemas:core:2.0:User" ], "id":"02826bf03710200044e0bfc8bcbe5d76", "displayName":"Jacinto Gawron" } ], "startIndex":6, "itemsPerPage":2 } ### Demande cURL utilisant un filtre {#scim-GET-Users__example_lkl_rjj_grb} L'exemple suivant montre comment utiliser le paramètre pour renvoyer les deux premiers enregistrements utilisateur dont le filter prénom commence par \<\< a \>\>. curl "https://instance-servicenow.com/api/now/scim/Users?filter=name.givenName%20SW%20%22a%22&count=2" \ --request GET \ --header "Accept:application/scim+json" \ Réponse : {"schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"], "totalResults":42, "Resources": [ { "schemas": [ "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User", "urn:ietf:params:scim:schemas:core:2.0:User" ], "id":"06826bf03710200044e0bfc8bcbe5d8a", "meta": { "resourceType":"User", "created":"2012-02-18T03:04:50Z", "lastModified":"2021-10-01T14:23:32Z", "location":"https://instance-servicenow.com/api/now/scim/Users/06826bf03710200044e0bfc8bcbe5d8a" }, "userName":"allyson.gillispie", "name": { "familyName":"Gillispie", "givenName":"Allyson" }, "displayName":"Allyson Gillispie", "active":true, "emails": [ { "value":"allyson.gillispie@example.com", "type":"work" } ], "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User": { "gender":"Female", "costCenter": { "value":"d9d07bddc0a80a647cf932056ed24652", "name":"Engineering" }, "company": { "value":"31bea3d53790200044e0bfc8bcbe5dec", "name":"ACME North America" }, "department": { "value":"221f3db5c6112284009f4becd3039cc9", "name":"Development" }, "location": { "value":"f9084ba00a0a0b910060ba2ce83f882b", "name":"946 Donax Avenue, Imperial Beach,CA" } } }, { "schemas": [ "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User", "urn:ietf:params:scim:schemas:core:2.0:User" ], "id":"0a826bf03710200044e0bfc8bcbe5d7a" "meta": { "resourceType":"User", "created":"2012-02-18T03:04:50Z", "lastModified":"2021-10-01T14:23:32Z", "location":"https://instance-servicenow.com/api/now/scim/Users/0a826bf03710200044e0bfc8bcbe5d7a" }, "userName":"adela.cervantsz", "name": { "familyName":"Cervantsz", "givenName":"Adela" }, "displayName":"Adela Cervantsz", "active":true, "emails": [ { "value":"adela.cervantsz@example.com", "type":"work" } ], "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User": { "gender":"Female", "costCenter": { "value":"91e8bbf43710200044e0bfc8bcbe5daa", "name":"Customer Support" }, "company": { "value":"31bea3d53790200044e0bfc8bcbe5dec", "name":"ACME North America" }, "department": { "value":"5d7f17f03710200044e0bfc8bcbe5d43", "name":"Customer Support" }, "location": { "value":"25ab93750a0a0bb30067bd2ef3d4a5c9", "name":"8306 Mills Drive, Miami,FL" } } } ], "startIndex":1, "itemsPerPage":2 } ## SCIM - GET /scim/Users/{user_id} {#ariaid-title10} Renvoie l'enregistrement utilisateur spécifié de la table Utilisateur \[sys_user\] au sein d'une ServiceNow instance utilisant le protocole SCIM (System for Cross-domain Identity Management). ### Format d'URL URL versionnée : /api/now/{api_version}/scim/Users/{user_id} URL par défaut : /api/now/scim/Users/{user_id} ### Paramètres de demande pris en charge {#scim-GET-Users-user_id__entry__2}{#scim-GET-Users-user_id__version-RESTAPI} | Nom | Description | |-|-| | api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne | | user_id | Sys_id de l'enregistrement utilisateur à renvoyer. Type de données : chaîne | [Tableau 61. Paramètres de chemin d'accès] {#scim-GET-Users-user_id__entry__8}{#scim-GET-Users-user_id__attributes-SCIM-entry}{#scim-GET-Users-user_id__excludedAttributes-SCIM-entry} | Nom | Description | |-|-| | attributs | Liste des champs séparés par des virgules à envoyer dans la réponse. Aucun autre champ n'est renvoyé. Ne peut pas être utilisé avec le excludedAttributes paramètre. Type de données : chaîne Par défaut : renvoie tous les champs sauf s'il excludedAttributes est spécifié. | | Attributs exclus | Liste de champs séparés par des virgules à exclure des enregistrements renvoyés dans la réponse. Tous les autres champs sont renvoyés. Ne peut pas être utilisé avec le attributes paramètre. Type de données : chaîne Par défaut : n'excluez aucun champ. | [Tableau 62. Paramètres de requête] {#scim-GET-Users-user_id__entry__14} | Nom | Description | |-|-| | Aucun | | [Tableau 63. Paramètres du corps de la demande (JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-GET-Users-user_id__entry__18}{#scim-GET-Users-user_id__Accept-SCIM-entry} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/scim+json. Valeur par défaut : application/json | [Tableau 64. En-têtes de demandes] {#scim-GET-Users-user_id__entry__22} | En-tête | Description | |-|-| | Aucun | | [Tableau 65. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-GET-Users-user_id__entry__26}{#scim-GET-Users-user_id__entry-200-status-code}{#scim-GET-Users-user_id__status_400-SCIM-entry}{#scim-GET-Users-user_id__entry-404-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. * Assurez-vous que les paramètres de requête et excludedAttributes n'ont attributes pas été transmis dans la demande. * Assurez-vous que le paramètre n'est count pas supérieur à 500. * Assurez-vous que tous les filter paramètres sont valides. {#scim-GET-Users-user_id__ul_vn1_gvz_nrb} | | 404 | Introuvable. L'élément demandé est introuvable. | [Tableau 66. Codes d'état] ### Paramètres de corps de réponse (JSON) {#scim-GET-Users-user_id__id_x11_hyj_grb__entry__2}{#scim-GET-Users-user_id__user_active-SCIM-entry}{#scim-GET-Users-user_id__user_addresses-SCIM-entry}{#scim-GET-Users-user_id__user_addresses_country-SCIM-entry}{#scim-GET-Users-user_id__user_addresses_locality-SCIM-entry}{#scim-GET-Users-user_id__user_addresses_postalCode-SCIM-entry}{#scim-GET-Users-user_id__user_addresses_region-SCIM-entry}{#scim-GET-Users-user_id__user_addresses_streetAddress-SCIM-entry}{#scim-GET-Users-user_id__user_addresses_type-SCIM-entry}{#scim-GET-Users-user_id__user_displayName-SCIM-entry}{#scim-GET-Users-user_id__user_emails-SCIM-entry}{#scim-GET-Users-user_id__user_emails_type-SCIM-entry}{#scim-GET-Users-user_id__user_emails_value-SCIM-entry}{#scim-GET-Users-user_id__user_emails_externalId-SCIM-entry}{#scim-GET-Users-user_id__user_groups-SCIM-entry}{#scim-GET-Users-user_id__user_groups_display-SCIM-entry}{#scim-GET-Users-user_id__user_groups_type-SCIM-entry}{#scim-GET-Users-user_id__user_groups_value-SCIM-entry}{#scim-GET-Users-user_id__user_groups_ref-SCIM-entry}{#scim-GET-Users-user_id__user_id-SCIM-entry}{#scim-GET-Users-user_id__user_meta-SCIM-entry}{#scim-GET-Users-user_id__user_meta_created-SCIM-entry}{#scim-GET-Users-user_id__user_meta_lastModified-SCIM-entry}{#scim-GET-Users-user_id__user_meta_location-SCIM-entry}{#scim-GET-Users-user_id__user_meta_resourceType-SCIM-entry}{#scim-GET-Users-user_id__user_name-SCIM-entry}{#scim-GET-Users-user_id__user_name_familyName-SCIM-entry}{#scim-GET-Users-user_id__user_name_givenName-SCIM-entry}{#scim-GET-Users-user_id__user_name_honorificPrefix-SCIM-entry}{#scim-GET-Users-user_id__user_name_middle-SCIM-entry}{#scim-GET-Users-user_id__user_phoneNumbers-SCIM-entry}{#scim-GET-Users-user_id__user_phoneNumbers_type-SCIM-entry}{#scim-GET-Users-user_id__user_phoneNumbers_value-SCIM-entry}{#scim-GET-Users-user_id__user_preferredLanguage-SCIM-entry}{#scim-GET-Users-user_id__user_schemas-SCIM-entry}{#scim-GET-Users-user_id__user_timezone-SCIM-entry}{#scim-GET-Users-user_id__user_title-SCIM-entry}{#scim-GET-Users-user_id__user_userName-SCIM-ph}{#scim-GET-Users-user_id__user_userType-SCIM-entry} | Nom | Description | |-|-| | Actif | Marqueur indiquant si l'utilisateur associé est actif au sein de l'instance ServiceNow . Valeurs possibles : * true : l'utilisateur est actif. * false : l'utilisateur est inactif. {#scim-GET-Users-user_id__ul_glm_qkj_grb} Type de données : booléennes | | addresses | Détails de l'adresse postale actuelle de l'utilisateur. Type de données : objet "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" } | | adresses.pays | Nom du pays. Type de données : chaîne | | adresses.localité | Nom de la ville ou de la localité. Type de données : chaîne | | addresses.postalCode | Code postal. Type de données : chaîne | | adresses.région | État ou région. Type de données : chaîne | | adresses.rueadresse | Adresse postale complète. Il peut s'agir du numéro de maison, du nom de la rue, de la boîte postale et de l'adresse postale étendue sur plusieurs lignes. Type de données : chaîne | | adresses.type | Type d'adresse. Ne prend actuellement en charge que la page d'accueil. Type de données : chaîne | | displayName | Nom d'affichage de l'utilisateur. Cette valeur est générée automatiquement par concaténation des name champs. Type de données : chaîne | | emails | Liste des comptes de messagerie associés à l'utilisateur. Type de données : tableau d'objets "emails:" [ { "type": "String", "value": "String" } ] | | e-mails.type | Type d'e-mail de l'utilisateur. Ne prend actuellement en charge que le type de \<\< travail \>\>. Type de données : chaîne | | e-mails.valeur | Adresse e-mail de l'utilisateur. Il s'agit d'une clé unique pour l'utilisateur associé. Type de données : chaîne | | externalId | Identificateur unique affecté à l'utilisateur par l'entité qui le provisionne. Type de données : chaîne | | groupes | Liste des groupes auxquels l'utilisateur appartient, soit par adhésion directe, soit par groupes imbriqués, soit calculée dynamiquement. Type de données : tableau d'objets "groups": [ { "display": "String", "type": "String", "value": "String", "$ref": "String" } ] | | groups.display | Nom du groupe associé. Type de données : chaîne | | groups.type | Type d'association de groupe, directe ou indirecte, par exemple. Type de données : chaîne | | Groupe.valeur | Sys_id d'un enregistrement de groupe associé. Type de données : chaîne | | groupes.$ref | URI du groupe associé. Type de données : chaîne | | id | Sys_id de l'enregistrement utilisateur associé. Type de données : chaîne | | métadonnées | Métadonnées relatives à l'utilisateur. Type de données : objet "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" } | | meta.created | Date et heure de création de l'enregistrement utilisateur. Type de données : chaîne | | meta.lastModified | Date et heure auxquelles l'enregistrement utilisateur a été modifié pour la dernière fois. Type de données : chaîne | | meta.location | L'URI de l'utilisateur en cours de récupération. Type de données : chaîne | | meta.resourceType | Type de ressource des utilisateurs SCIM. Type de données : chaîne | | nom | Informations sur le nom de l'utilisateur. Type de données : objet "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" } | | nom.nom.nom de famille | Nom de famille ou nom de famille de l'utilisateur. Type de données : chaîne | | nom.nomdonné | Prénom de l'utilisateur. Type de données : chaîne | | nom.honorificPrefix | Nom ou titre honorifique de l'utilisateur, tel que Dr., Bishop ou Baron. Type de données : chaîne | | nom.deuxième prénom | Deuxième prénom de l'utilisateur. Type de données : chaîne | | phoneNumbers | Liste des numéros de téléphone associés à l'utilisateur. Type de données : tableau d'objets "phoneNumbers": [ { "type": "String", "value": "String" } ] | | phoneNumbers.type | Type de numéro de téléphone. Valeurs possibles : * accueil * mobile * travail {#scim-GET-Users-user_id__ul_idb_brj_grb} Type de données : chaîne | | phoneNumbers.value | Numéro de téléphone de l'utilisateur. Type de données : chaîne | | preferredLanguage | Langue parlée et écrite préférée de l'utilisateur. Type de données : chaîne | | Schémas | Liste des URI des schémas d'utilisateur SCIM utilisés pour traiter la demande. Type de données : tableau de chaînes | | fuseau horaire | Fuseau horaire de l'utilisateur. Type de données : chaîne | | Titre | Titre de l'utilisateur, par exemple PDG ou Président. Type de données : chaîne | | userName | Nom d'utilisateur unique pour l'utilisateur associé. Type de données : chaîne | | Type d'utilisateur | Type d'utilisateur. Cette valeur est utilisée pour identifier la relation entre l'organisation et l'utilisateur. Il peut s'agir de n'importe quelle valeur, mais les valeurs typiques peuvent inclure : * Prestataire * Employé * Interne * Intérimaire * Externe * Inconnu {#scim-GET-Users-user_id__ul_kdr_nwz_nrb} Type de données : chaîne | [ ] {#scim-GET-Users-user_id__id_x11_hyj_grb} ### Paramètres d'extension retournés {#scim-GET-Users-user_id__section_vb2_yny_jlb} {#scim-GET-Users-user_id__id_hmw_fjk_grb__entry__2}{#scim-GET-Users-user_id__user_company-SCIM-entry}{#scim-GET-Users-user_id__user_company_display-SCIM-entry}{#scim-GET-Users-user_id__user_company_value-SCIM-ph}{#scim-GET-Users-user_id__user_company_ref-SCIM-entry}{#scim-GET-Users-user_id__user_costCenter-SCIM-entry}{#scim-GET-Users-user_id__user_costCenter_display-SCIM-entry}{#scim-GET-Users-user_id__user_costCenter_value-SCIM-ph}{#scim-GET-Users-user_id__user_costCenter_ref-SCIM-entry}{#scim-GET-Users-user_id__user_department-SCIM-entry}{#scim-GET-Users-user_id__user_department_display-SCIM-entry}{#scim-GET-Users-user_id__user_department_value-SCIM-ph}{#scim-GET-Users-user_id__user_department_ref-SCIM-entry}{#scim-GET-Users-user_id__user_employeeNumber-SCIM-entry}{#scim-GET-Users-user_id__user_gender-SCIM-entry}{#scim-GET-Users-user_id__user_location-SCIM-entry}{#scim-GET-Users-user_id__user_location_display-SCIM-entry}{#scim-GET-Users-user_id__user_location_value-SCIM-ph}{#scim-GET-Users-user_id__user_location_ref-SCIM-entry}{#scim-GET-Users-user_id__user_manager-SCIM-entry}{#scim-GET-Users-user_id__user_manager_display-SCIM-entry}{#scim-GET-Users-user_id__user_manager_value-SCIM-ph}{#scim-GET-Users-user_id__user_manager_ref-SCIM-entry} | Nom | Description | |-|-| | company | Détails sur la société associée à l'utilisateur. Type de données : objet "company": { "display": "String", "value": "String", "$ref": "String" } | | entreprise.display | Nom de la société. Type de données : chaîne | | entreprise.valeur | Sys_id de l'enregistrement de société. Type de données : chaîne | | entreprise.$ref | URI de référence pour la société. Type de données : chaîne | | Centre de coûts | Détails sur le centre de coûts associé à l'utilisateur. Type de données : objet "costCenter": { "display": "String", "value": "String", "$ref": "String" } | | centredecoûts.affichage | Nom du centre de coûts. Type de données : chaîne | | centre-coûts.valeur | Sys_id de l'enregistrement de centre de coûts. Type de données : chaîne | | centredecoûts.$ref | URI de référence pour le centre de coûts. Type de données : chaîne | | département | Détails sur le département associé à l'utilisateur. Type de données : objet "department": { "display": "String", "value": "String", "$ref": "String" } | | department.display | Nom du département. Type de données : chaîne | | valeur.département | Sys_id de l'enregistrement du département. Type de données : chaîne | | département.$ref | URI de référence pour le département. Type de données : chaîne | | employeeNumber | Numéro d'employé numérique ou alphanumérique. Type de données : chaîne | | sexe | Sexe de l'utilisateur, par exemple homme ou femme. Type de données : chaîne | | emplacement | Détails sur l'emplacement associé de l'utilisateur. Type de données : objet "location": { "display": "String", "value": "String", "$ref": "String" } | | Emplacement.Affichage | Nom de l'emplacement. Type de données : chaîne | | Emplacement.valeur | Sys_id de l'enregistrement de l'emplacement. Type de données : chaîne | | l'emplacement.$ref | URI de référence pour l'emplacement. Type de données : chaîne | | responsable | Détails sur le gestionnaire associé à l'utilisateur. Type de données : objet "manager": { "display": "String", "value": "String", "$ref": "String" } | | manager.display | Nom du gestionnaire. Type de données : chaîne | | gestionnaire.valeur | Sys_id de l'enregistrement du gestionnaire. Type de données : chaîne | | gestionnaire.$ref | URI de référence pour le gestionnaire. Type de données : chaîne | [ ] {#scim-GET-Users-user_id__id_hmw_fjk_grb} ### Demande cURL à l'aide de l'sys_id de l'utilisateur L'exemple suivant montre comment obtenir un enregistrement d'utilisateur spécifique en transmettant leur sys_id. curl "https://instance-servicenow.com/api/now/scim/Users/62826bf03710200044e0bfc8bcbe5df1" \ --request GET \ --header "Accept:application/scim+json" \ Réponse : {"schemas": [ "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User", "urn:ietf:params:scim:schemas:core:2.0:User" ], "id":"62826bf03710200044e0bfc8bcbe5df1", "meta": { "resourceType":"User", "created":"2012-02-18T03:04:52Z", "lastModified":"2021-10-01T14:23:34Z", "location":"https://instance-servicenow.com/api/now/scim/Users/62826bf03710200044e0bfc8bcbe5df1" }, "userName":"abel.tuter", "name": { "familyName":"Tuter", "givenName":"Abel" }, "displayName":"Abel Tuter", "active":true, "emails":[ { "value":"abel.tuter@example.com", "type":"work" } ], "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User": { "gender":"Male", "costCenter": { "value":"d9d07bddc0a80a647cf932056ed24652", "name":"Engineering" }, "company": { "value":"227cdfb03710200044e0bfc8bcbe5d6b", "name":"ACME South America" }, "department": { "value":"9a7ed3f03710200044e0bfc8bcbe5db7", "name":"Product Management" }, "location": { "value":"25b3d04b0a0a0bb300176b546c22db27", "name":"SHS quadra 5, Bloco E., Brasilia"} } } ## SCIM - PATCH /scim/Users/{user_id} {#ariaid-title11} Permet d'ajouter, de remplacer et de supprimer des champs spécifiés dans un enregistrement utilisateur dans la table Utilisateur \[sys_user\] d'une ServiceNow instance utilisant le protocole SCIM (System for Cross-domain Identity Management). ### Format d'URL URL versionnée : /api/now/{api_version}/scim/Users/{user_id} URL par défaut : /api/now/scim/Users/{user_id} ### Paramètres de demande pris en charge {#scim-PATCH-Users-user_id__entry__2}{#scim-PATCH-Users-user_id__version-RESTAPI} | Nom | Description | |-|-| | api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne | | user_id | Sys_id de l'enregistrement utilisateur à modifier. | [Tableau 67. Paramètres de chemin d'accès] {#scim-PATCH-Users-user_id__entry__8}{#scim-PATCH-Users-user_id__attributes-SCIM-entry}{#scim-PATCH-Users-user_id__excludedAttributes-SCIM-entry} | Nom | Description | |-|-| | attributs | Liste des champs séparés par des virgules à envoyer dans la réponse. Aucun autre champ n'est renvoyé. Ne peut pas être utilisé avec le excludedAttributes paramètre. Type de données : chaîne Par défaut : renvoie tous les champs sauf s'il excludedAttributes est spécifié. | | Attributs exclus | Liste de champs séparés par des virgules à exclure des enregistrements renvoyés dans la réponse. Tous les autres champs sont renvoyés. Ne peut pas être utilisé avec le attributes paramètre. Type de données : chaîne Par défaut : n'excluez aucun champ. | [Tableau 68. Paramètres de requête] {#scim-PATCH-Users-user_id__entry__14} | Nom | Description | |-|-| | Opérations | Requis. Liste des objets d'opération avec lesquels appliquer un correctif à l'enregistrement utilisateur spécifié. Type de données : tableau "Operations": [ { "op": "String", "path": "String", "value": Any } ] | | Opérations.op | Requis. Opération à effectuer. Valeurs valides : * ajouter : ajouter le champ et la valeur spécifiés à l'enregistrement utilisateur. * Supprimer : supprimez la valeur du champ spécifié. * remplacer : remplacez la valeur du champ spécifié. {#scim-PATCH-Users-user_id__ul_zcf_ydv_frb} Type de données : chaîne | | Chemin.Opérations.Chemin d'accès | Requis pour `les opérations de suppression` . Nom/chemin d'accès du champ à modifier. Le path paramètre peut avoir l'un des formats suivants : * Un champ direct, tel que `le titre` * Un champ imbriqué, tel que `name.givenName` * Dans le cas d'un tableau complexe, il peut pointer vers un élément spécifique avec un filtre, tel que : `emails[type eq << work"]` {#scim-PATCH-Users-user_id__ul_zpv_ls5_frb} { "schemas": [ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ], "Operations": [ { "op": "add", "path": "title", "value": "xyz" }, { "op": "replace", "path": "name.givenName", "value": "Jennifer" }, { "op": "replace", "path": "emails[type eq \"work\"]", "value": "xyz@test.com" } ] } Type de données : chaîne Par défaut : considère le champ comme une ressource utilisateur. | | Operations.value | Valeur du champ spécifié dans le Operations.path paramètre. Le format de ce paramètre dépend du type de données du champ associé. Par exemple, si vous mettez à jour une chaîne simple, telle que le titre, le value champ est exprimé sous forme de chaîne. "Operations": [ { "op": "add", "path": "title", "value": "xyz" } ] Vous pouvez également déclarer des valeurs de chaîne simples sans utiliser value les paramètres or path , telles que : "Operations": [ { "op": "add", "title": "xyz" } ] Toutefois, lors de la mise à jour d'un numéro de téléphone, qui est un tableau contenant des objets définissant des champs supplémentaires à ajouter à l'enregistrement utilisateur et leurs valeurs associées, le value champ est exprimé sous la forme d'un tableau d'objets. "Operations": [ { "op": "add", "path": "phoneNumbers", "value": [ { "type": "work", "value": "9876543210" }, { "type": "home", "value": "9876783216" } ] } ] Lors de la spécification de nœuds d'attributs, l'entrée peut inclure l'imbrication comme suit : { "op": "replace", "value": { "name": { "familyName": "Jones", "givenName": "Jennifer" } } } Ou vous pouvez spécifier l'imbrication dans le Operations.path: { "op": "replace", "path": "name.givenName", "value": "Jennifer" } Si le champ mis à jour n'est pas dans le schéma de base, vous devez entourer la paire nom-valeur dans un objet qui spécifie l'URN du schéma associé. "value": { "": { "": "" }, } Par exemple : "value": { "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User": { "employeeNumber": "13454" }, } Type de données : N'importe lequel | | Opération.valeur.type | Nom du champ à mettre à jour. Type de données : chaîne | | Opérations.valeur.valeur | Valeur avec laquelle mettre à jour le champ. Type de données : chaîne | | Schémas | Requis. URI de schéma SCIM de l'opération du correctif `urn :ietf :params :scim :api :messages :2.0 :PatchOp`. Type de données : chaîne | [Tableau 69. Paramètres du corps de la demande (JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-PATCH-Users-user_id__entry__30}{#scim-PATCH-Users-user_id__Accept-SCIM-entry}{#scim-PATCH-Users-user_id__Content_Type-SCIM-entry} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/scim+json. Valeur par défaut : application/json | | Content-Type | Format de données du corps de la demande. Types pris en charge : application/json ou application/scim+json. Valeur par défaut : application/json | [Tableau 70. En-têtes de demandes] {#scim-PATCH-Users-user_id__entry__36} | En-tête | Description | |-|-| | Aucun | | [Tableau 71. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-PATCH-Users-user_id__entry__40}{#scim-PATCH-Users-user_id__entry-200-status-code}{#scim-PATCH-Users-user_id__entry-404-status-code}{#scim-PATCH-Users-user_id__entry-500-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. * Vérifier les valeurs non valides : * Corps de demande mal formé. * Le champ obligatoire n'est pas fourni ou vide. * Un sys_id d'utilisateur ou de groupe non valide est fourni. {#scim-PATCH-Users-user_id__ul_dwt_rtd_grb} * Vérifiez si un champ en lecture seule ou immuable essaie d'être modifié. * Assurez-vous que les paramètres de requête et excludedAttributes n'ont attributes pas été transmis dans la demande ou que la demande ne dépasse pas le nombre maximal de membres. {#scim-PATCH-Users-user_id__ul_ypm_ptd_grb} | | 404 | Introuvable. L'élément demandé est introuvable. | | 409 | L'utilisateur existe déjà. Le userName paramètre doit être unique. | | 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. | [Tableau 72. Codes d'état] ### Paramètres de corps de réponse (JSON) {#scim-PATCH-Users-user_id__table_mjy_k1l_grb__entry__2}{#scim-PATCH-Users-user_id__user_active-SCIM-entry}{#scim-PATCH-Users-user_id__user_addresses-SCIM-entry}{#scim-PATCH-Users-user_id__user_addresses_country-SCIM-entry}{#scim-PATCH-Users-user_id__user_addresses_locality-SCIM-entry}{#scim-PATCH-Users-user_id__user_addresses_postalCode-SCIM-entry}{#scim-PATCH-Users-user_id__user_addresses_region-SCIM-entry}{#scim-PATCH-Users-user_id__user_addresses_streetAddress-SCIM-entry}{#scim-PATCH-Users-user_id__user_addresses_type-SCIM-entry}{#scim-PATCH-Users-user_id__user_displayName-SCIM-entry}{#scim-PATCH-Users-user_id__user_emails-SCIM-entry}{#scim-PATCH-Users-user_id__user_emails_type-SCIM-entry}{#scim-PATCH-Users-user_id__user_emails_value-SCIM-entry}{#scim-PATCH-Users-user_id__errors-SCIM-entry}{#scim-PATCH-Users-user_id__errors_details-SCIM-entry}{#scim-PATCH-Users-user_id__errors_scimType-SCIM-entry}{#scim-PATCH-Users-user_id__errors_schemas-SCIM-entry}{#scim-PATCH-Users-user_id__errors_status-SCIM-entry}{#scim-PATCH-Users-user_id__user_emails_externalId-SCIM-entry}{#scim-PATCH-Users-user_id__user_groups-SCIM-entry}{#scim-PATCH-Users-user_id__user_groups_display-SCIM-entry}{#scim-PATCH-Users-user_id__user_groups_type-SCIM-entry}{#scim-PATCH-Users-user_id__user_groups_value-SCIM-entry}{#scim-PATCH-Users-user_id__user_groups_ref-SCIM-entry}{#scim-PATCH-Users-user_id__user_id-SCIM-entry}{#scim-PATCH-Users-user_id__user_meta-SCIM-entry}{#scim-PATCH-Users-user_id__user_meta_created-SCIM-entry}{#scim-PATCH-Users-user_id__user_meta_lastModified-SCIM-entry}{#scim-PATCH-Users-user_id__user_meta_location-SCIM-entry}{#scim-PATCH-Users-user_id__user_meta_resourceType-SCIM-entry}{#scim-PATCH-Users-user_id__user_name-SCIM-entry}{#scim-PATCH-Users-user_id__user_name_familyName-SCIM-entry}{#scim-PATCH-Users-user_id__user_name_givenName-SCIM-entry}{#scim-PATCH-Users-user_id__user_name_honorificPrefix-SCIM-entry}{#scim-PATCH-Users-user_id__user_name_middle-SCIM-entry}{#scim-PATCH-Users-user_id__user_phoneNumbers-SCIM-entry}{#scim-PATCH-Users-user_id__user_phoneNumbers_type-SCIM-entry}{#scim-PATCH-Users-user_id__user_phoneNumbers_value-SCIM-entry}{#scim-PATCH-Users-user_id__user_preferredLanguage-SCIM-entry}{#scim-PATCH-Users-user_id__user_schemas-SCIM-entry}{#scim-PATCH-Users-user_id__user_timezone-SCIM-entry}{#scim-PATCH-Users-user_id__user_title-SCIM-entry}{#scim-PATCH-Users-user_id__user_userName-SCIM-ph}{#scim-PATCH-Users-user_id__user_userType-SCIM-entry} | Nom | Description | |-|-| | Actif | Marqueur indiquant si l'utilisateur associé est actif au sein de l'instance ServiceNow . Valeurs possibles : * true : l'utilisateur est actif. * false : l'utilisateur est inactif. {#scim-PATCH-Users-user_id__ul_glm_qkj_grb} Type de données : booléennes | | addresses | Détails de l'adresse postale actuelle de l'utilisateur. Type de données : objet "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" } | | adresses.pays | Nom du pays. Type de données : chaîne | | adresses.localité | Nom de la ville ou de la localité. Type de données : chaîne | | addresses.postalCode | Code postal. Type de données : chaîne | | adresses.région | État ou région. Type de données : chaîne | | adresses.rueadresse | Adresse postale complète. Il peut s'agir du numéro de maison, du nom de la rue, de la boîte postale et de l'adresse postale étendue sur plusieurs lignes. Type de données : chaîne | | adresses.type | Type d'adresse. Ne prend actuellement en charge que la page d'accueil. Type de données : chaîne | | displayName | Nom d'affichage de l'utilisateur. Cette valeur est générée automatiquement par concaténation des name champs. Type de données : chaîne | | emails | Liste des comptes de messagerie associés à l'utilisateur. Type de données : tableau d'objets "emails:" [ { "type": "String", "value": "String" } ] | | e-mails.type | Type d'e-mail de l'utilisateur. Ne prend actuellement en charge que le type de \<\< travail \>\>. Type de données : chaîne | | e-mails.valeur | Adresse e-mail de l'utilisateur. Il s'agit d'une clé unique pour l'utilisateur associé. Type de données : chaîne | | erreurs | Réponse décrivant toute erreur qui a pu se produire pendant le traitement de la demande. Type de données : objet "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" } | | errors.detail | Message d'erreur détaillé expliquant pourquoi la demande a échoué. Type de données : chaîne | | errors.scimType | Mot clé de détail de l'erreur SCIM. Type de données : chaîne | | Schémas.erreurs | URI des schémas SCIM utilisés pour traiter la réponse d'erreur. Type de données : tableau de chaînes | | erreurs.état | Code d'état HTTP de la réponse d'erreur. Type de données : chaîne | | externalId | Identificateur unique affecté à l'utilisateur par l'entité qui le provisionne. Type de données : chaîne | | groupes | Liste des groupes auxquels l'utilisateur appartient, soit par adhésion directe, soit par groupes imbriqués, soit calculée dynamiquement. Type de données : tableau d'objets "groups": [ { "display": "String", "type": "String", "value": "String", "$ref": "String" } ] | | groups.display | Nom du groupe associé. Type de données : chaîne | | groups.type | Type d'association de groupe, directe ou indirecte, par exemple. Type de données : chaîne | | Groupe.valeur | Sys_id d'un enregistrement de groupe associé. Type de données : chaîne | | groupes.$ref | URI du groupe associé. Type de données : chaîne | | id | Sys_id de l'enregistrement utilisateur associé. Type de données : chaîne | | métadonnées | Métadonnées relatives à l'utilisateur. Type de données : objet "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" } | | meta.created | Date et heure de création de l'enregistrement utilisateur. Type de données : chaîne | | meta.lastModified | Date et heure auxquelles l'enregistrement utilisateur a été modifié pour la dernière fois. Type de données : chaîne | | meta.location | L'URI de l'utilisateur en cours de récupération. Type de données : chaîne | | meta.resourceType | Type de ressource des utilisateurs SCIM. Type de données : chaîne | | nom | Informations sur le nom de l'utilisateur. Type de données : objet "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" } | | nom.nom.nom de famille | Nom de famille ou nom de famille de l'utilisateur. Type de données : chaîne | | nom.nomdonné | Prénom de l'utilisateur. Type de données : chaîne | | nom.honorificPrefix | Nom ou titre honorifique de l'utilisateur, tel que Dr., Bishop ou Baron. Type de données : chaîne | | nom.deuxième prénom | Deuxième prénom de l'utilisateur. Type de données : chaîne | | phoneNumbers | Liste des numéros de téléphone associés à l'utilisateur. Type de données : tableau d'objets "phoneNumbers": [ { "type": "String", "value": "String" } ] | | phoneNumbers.type | Type de numéro de téléphone. Valeurs possibles : * accueil * mobile * travail {#scim-PATCH-Users-user_id__ul_idb_brj_grb} Type de données : chaîne | | phoneNumbers.value | Numéro de téléphone de l'utilisateur. Type de données : chaîne | | preferredLanguage | Langue parlée et écrite préférée de l'utilisateur. Type de données : chaîne | | Schémas | Liste des URI des schémas d'utilisateur SCIM utilisés pour traiter la demande. Type de données : tableau de chaînes | | fuseau horaire | Fuseau horaire de l'utilisateur. Type de données : chaîne | | Titre | Titre de l'utilisateur, par exemple PDG ou Président. Type de données : chaîne | | userName | Nom d'utilisateur unique pour l'utilisateur associé. Type de données : chaîne | | Type d'utilisateur | Type d'utilisateur. Cette valeur est utilisée pour identifier la relation entre l'organisation et l'utilisateur. Il peut s'agir de n'importe quelle valeur, mais les valeurs typiques peuvent inclure : * Prestataire * Employé * Interne * Intérimaire * Externe * Inconnu {#scim-PATCH-Users-user_id__ul_kdr_nwz_nrb} Type de données : chaîne | [ ] {#scim-PATCH-Users-user_id__table_mjy_k1l_grb} ### Paramètres d'extension retournés {#scim-PATCH-Users-user_id__section_vb2_yny_jlb} {#scim-PATCH-Users-user_id__id_hmw_fjk_grb__entry__2}{#scim-PATCH-Users-user_id__user_company-SCIM-entry}{#scim-PATCH-Users-user_id__user_company_display-SCIM-entry}{#scim-PATCH-Users-user_id__user_company_value-SCIM-ph}{#scim-PATCH-Users-user_id__user_company_ref-SCIM-entry}{#scim-PATCH-Users-user_id__user_costCenter-SCIM-entry}{#scim-PATCH-Users-user_id__user_costCenter_display-SCIM-entry}{#scim-PATCH-Users-user_id__user_costCenter_value-SCIM-ph}{#scim-PATCH-Users-user_id__user_costCenter_ref-SCIM-entry}{#scim-PATCH-Users-user_id__user_department-SCIM-entry}{#scim-PATCH-Users-user_id__user_department_display-SCIM-entry}{#scim-PATCH-Users-user_id__user_department_value-SCIM-ph}{#scim-PATCH-Users-user_id__user_department_ref-SCIM-entry}{#scim-PATCH-Users-user_id__user_employeeNumber-SCIM-entry}{#scim-PATCH-Users-user_id__user_gender-SCIM-entry}{#scim-PATCH-Users-user_id__user_location-SCIM-entry}{#scim-PATCH-Users-user_id__user_location_display-SCIM-entry}{#scim-PATCH-Users-user_id__user_location_value-SCIM-ph}{#scim-PATCH-Users-user_id__user_location_ref-SCIM-entry}{#scim-PATCH-Users-user_id__user_manager-SCIM-entry}{#scim-PATCH-Users-user_id__user_manager_display-SCIM-entry}{#scim-PATCH-Users-user_id__user_manager_value-SCIM-ph}{#scim-PATCH-Users-user_id__user_manager_ref-SCIM-entry} | Nom | Description | |-|-| | company | Détails sur la société associée à l'utilisateur. Type de données : objet "company": { "display": "String", "value": "String", "$ref": "String" } | | entreprise.display | Nom de la société. Type de données : chaîne | | entreprise.valeur | Sys_id de l'enregistrement de société. Type de données : chaîne | | entreprise.$ref | URI de référence pour la société. Type de données : chaîne | | Centre de coûts | Détails sur le centre de coûts associé à l'utilisateur. Type de données : objet "costCenter": { "display": "String", "value": "String", "$ref": "String" } | | centredecoûts.affichage | Nom du centre de coûts. Type de données : chaîne | | centre-coûts.valeur | Sys_id de l'enregistrement de centre de coûts. Type de données : chaîne | | centredecoûts.$ref | URI de référence pour le centre de coûts. Type de données : chaîne | | département | Détails sur le département associé à l'utilisateur. Type de données : objet "department": { "display": "String", "value": "String", "$ref": "String" } | | department.display | Nom du département. Type de données : chaîne | | valeur.département | Sys_id de l'enregistrement du département. Type de données : chaîne | | département.$ref | URI de référence pour le département. Type de données : chaîne | | employeeNumber | Numéro d'employé numérique ou alphanumérique. Type de données : chaîne | | sexe | Sexe de l'utilisateur, par exemple homme ou femme. Type de données : chaîne | | emplacement | Détails sur l'emplacement associé de l'utilisateur. Type de données : objet "location": { "display": "String", "value": "String", "$ref": "String" } | | Emplacement.Affichage | Nom de l'emplacement. Type de données : chaîne | | Emplacement.valeur | Sys_id de l'enregistrement de l'emplacement. Type de données : chaîne | | l'emplacement.$ref | URI de référence pour l'emplacement. Type de données : chaîne | | responsable | Détails sur le gestionnaire associé à l'utilisateur. Type de données : objet "manager": { "display": "String", "value": "String", "$ref": "String" } | | manager.display | Nom du gestionnaire. Type de données : chaîne | | gestionnaire.valeur | Sys_id de l'enregistrement du gestionnaire. Type de données : chaîne | | gestionnaire.$ref | URI de référence pour le gestionnaire. Type de données : chaîne | [ ] {#scim-PATCH-Users-user_id__id_hmw_fjk_grb} ### Demande cURL L'exemple suivant montre comment ajouter, supprimer et remplacer des valeurs dans un enregistrement utilisateur. curl -X PATCH \ https://instance-servicenow.com/api/now/scim/Users/005d500b536073005e0addeeff7b12f4 \ -d '{ "schemas": [ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ], "Operations": [ { "op" : "remove", "path" : "title" }, { "op" : "add", "path" : "phoneNumbers", "value" : [ { "type" : "work", "value" : "9876543210" } ] }, { "op": "replace", "value": { "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User": { "employeeNumber": "13454" }, "name": { "familyName": "John", "givenName": "Smith" } } } ] }' Réponse : { "schemas":[ "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User", "urn:ietf:params:scim:schemas:core:2.0:User" ], "id":"005d500b536073005e0addeeff7b12f4", "meta":{ "resourceType":"User", "created":"2019-04-05T21:09:12Z", "lastModified":"2021-10-12T18:29:27Z", "location":"https://instance-servicenow.com/api/now/scim/Users/005d500b536073005e0addeeff7b12f4" }, "userName":"survey.user", "name":{ "familyName":"John", "givenName":"Smith" }, "displayName":"Smith John", "active":true, "emails":[ { "value":"survey.user@email.com", "type":"work" } ], "phoneNumbers":[ { "value":"9876543210", "type":"work" } ], "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User":{ "employeeNumber":"13454" } } ## SCIM - POST /scim/Users {#ariaid-title12} Crée un enregistrement d'utilisateur dans la table Utilisateur \[sys_user\] d'une ServiceNow instance à l'aide du protocole SCIM (System for Cross-domain Identity Management). Remarque : Les fonctionnalités de recherche et de modifications en bloc indiquées dans la spécification RFC7643 ne sont pas prises en charge par ce point de terminaison. ### Format d'URL URL versionnée : /api/now/{api_version}/scim/Users URL par défaut : /api/now/scim/Users ### Paramètres de demande pris en charge {#scim-POST-Users__entry__2}{#scim-POST-Users__version-RESTAPI} | Nom | Description | |-|-| | api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne | [Tableau 73. Paramètres de chemin d'accès] {#scim-POST-Users__entry__6}{#scim-POST-Users__attributes-SCIM-entry}{#scim-POST-Users__excludedAttributes-SCIM-entry} | Nom | Description | |-|-| | attributs | Liste des champs séparés par des virgules à envoyer dans la réponse. Aucun autre champ n'est renvoyé. Ne peut pas être utilisé avec le excludedAttributes paramètre. Type de données : chaîne Par défaut : renvoie tous les champs sauf s'il excludedAttributes est spécifié. | | Attributs exclus | Liste de champs séparés par des virgules à exclure des enregistrements renvoyés dans la réponse. Tous les autres champs sont renvoyés. Ne peut pas être utilisé avec le attributes paramètre. Type de données : chaîne Par défaut : n'excluez aucun champ. | [Tableau 74. Paramètres de requête] {#scim-POST-Users__entry__12}{#scim-POST-Users__user_active-SCIM-entry}{#scim-POST-Users__user_addresses-SCIM-entry}{#scim-POST-Users__user_addresses_country-SCIM-entry}{#scim-POST-Users__user_addresses_locality-SCIM-entry}{#scim-POST-Users__user_addresses_postalCode-SCIM-entry}{#scim-POST-Users__user_addresses_region-SCIM-entry}{#scim-POST-Users__user_addresses_streetAddress-SCIM-entry}{#scim-POST-Users__user_addresses_type-SCIM-entry}{#scim-POST-Users__user_displayName-SCIM-entry}{#scim-POST-Users__user_emails-SCIM-entry}{#scim-POST-Users__user_emails_type-SCIM-entry}{#scim-POST-Users__user_emails_value-SCIM-entry}{#scim-POST-Users__user_emails_externalId-SCIM-entry}{#scim-POST-Users__user_name-SCIM-entry}{#scim-POST-Users__user_name_familyName-SCIM-entry}{#scim-POST-Users__user_name_givenName-SCIM-entry}{#scim-POST-Users__user_name_honorificPrefix-SCIM-entry}{#scim-POST-Users__user_name_middle-SCIM-entry}{#scim-POST-Users__user_phoneNumbers-SCIM-entry}{#scim-POST-Users__user_phoneNumbers_type-SCIM-entry}{#scim-POST-Users__user_phoneNumbers_value-SCIM-entry}{#scim-POST-Users__user_preferredLanguage-SCIM-entry}{#scim-POST-Users__user_timezone-SCIM-entry}{#scim-POST-Users__user_title-SCIM-entry}{#scim-POST-Users__user_userType-SCIM-entry}{#scim-POST-Users__user_employeeNumber-SCIM-entry}{#scim-POST-Users__user_gender-SCIM-entry} | Nom | Description | |-|-| | Actif | Marqueur indiquant si l'utilisateur associé est actif au sein de l'instance ServiceNow . Valeurs possibles : * true : l'utilisateur est actif. * false : l'utilisateur est inactif. {#scim-POST-Users__ul_glm_qkj_grb} Type de données : booléennes | | addresses | Détails de l'adresse postale actuelle de l'utilisateur. Type de données : objet "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" } | | adresses.pays | Nom du pays. Type de données : chaîne | | adresses.localité | Nom de la ville ou de la localité. Type de données : chaîne | | addresses.postalCode | Code postal. Type de données : chaîne | | adresses.région | État ou région. Type de données : chaîne | | adresses.rueadresse | Adresse postale complète. Il peut s'agir du numéro de maison, du nom de la rue, de la boîte postale et de l'adresse postale étendue sur plusieurs lignes. Type de données : chaîne | | adresses.type | Type d'adresse. Ne prend actuellement en charge que la page d'accueil. Type de données : chaîne | | displayName | Nom d'affichage de l'utilisateur. Cette valeur est générée automatiquement par concaténation des name champs. Type de données : chaîne | | emails | Liste des comptes de messagerie associés à l'utilisateur. Type de données : tableau d'objets "emails:" [ { "type": "String", "value": "String" } ] | | e-mails.type | Type d'e-mail de l'utilisateur. Ne prend actuellement en charge que le type de \<\< travail \>\>. Type de données : chaîne | | e-mails.valeur | Adresse e-mail de l'utilisateur. Il s'agit d'une clé unique pour l'utilisateur associé. Type de données : chaîne | | externalId | Identificateur unique affecté à l'utilisateur par l'entité qui le provisionne. Type de données : chaîne | | nom | Informations sur le nom de l'utilisateur. Type de données : objet "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" } | | nom.nom.nom de famille | Nom de famille ou nom de famille de l'utilisateur. Type de données : chaîne | | nom.nomdonné | Prénom de l'utilisateur. Type de données : chaîne | | nom.honorificPrefix | Nom ou titre honorifique de l'utilisateur, tel que Dr., Bishop ou Baron. Type de données : chaîne | | nom.deuxième prénom | Deuxième prénom de l'utilisateur. Type de données : chaîne | | phoneNumbers | Liste des numéros de téléphone associés à l'utilisateur. Type de données : tableau d'objets "phoneNumbers": [ { "type": "String", "value": "String" } ] | | phoneNumbers.type | Type de numéro de téléphone. Valeurs possibles : * accueil * mobile * travail {#scim-POST-Users__ul_idb_brj_grb} Type de données : chaîne | | phoneNumbers.value | Numéro de téléphone de l'utilisateur. Type de données : chaîne | | preferredLanguage | Langue parlée et écrite préférée de l'utilisateur. Type de données : chaîne | | fuseau horaire | Fuseau horaire de l'utilisateur. Type de données : chaîne | | Titre | Titre de l'utilisateur, par exemple PDG ou Président. Type de données : chaîne | | userName | Requis. Nom d'utilisateur unique pour l'utilisateur associé. Type de données : chaîne | | Type d'utilisateur | Type d'utilisateur. Cette valeur est utilisée pour identifier la relation entre l'organisation et l'utilisateur. Il peut s'agir de n'importe quelle valeur, mais les valeurs typiques peuvent inclure : * Prestataire * Employé * Interne * Intérimaire * Externe * Inconnu {#scim-POST-Users__ul_kdr_nwz_nrb} Type de données : chaîne | | Schéma étendu | | | company | Détails sur la société associée à l'utilisateur. Type de données : objet "company": { "value": "String" } | | entreprise.valeur | Requis si l'entreprise est incluse dans la publication. Sys_id de l'enregistrement de société. Type de données : chaîne | | Centre de coûts | Détails sur le centre de coûts associé à l'utilisateur. Type de données : objet "costCenter": { "value": "String" } | | centre-coûts.valeur | Requis si CostCenter est inclus dans la publication. Sys_id de l'enregistrement de centre de coûts. Type de données : chaîne | | département | Détails sur le département associé à l'utilisateur. Type de données : objet "department": { "value": "String" } | | valeur.département | Obligatoire si le département est inclus dans la publication. Sys_id de l'enregistrement du département. Type de données : chaîne | | employeeNumber | Numéro d'employé numérique ou alphanumérique. Type de données : chaîne | | sexe | Sexe de l'utilisateur, par exemple homme ou femme. Type de données : chaîne | | emplacement | Détails sur l'emplacement associé de l'utilisateur. Type de données : objet "location": { "value": "String" } | | Emplacement.valeur | Requis si l'emplacement est inclus dans la publication. Sys_id de l'enregistrement de l'emplacement. Type de données : chaîne | | responsable | Détails sur le gestionnaire associé à l'utilisateur. Type de données : objet "manager": { "value": "String" } | | gestionnaire.valeur | Requis si le gestionnaire est inclus dans la publication. Sys_id de l'enregistrement du gestionnaire. Type de données : chaîne | [Tableau 75. Paramètres de corps de demande (XML ou JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-POST-Users__entry__92}{#scim-POST-Users__Accept-SCIM-entry}{#scim-POST-Users__Content_Type-SCIM-entry} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/scim+json. Valeur par défaut : application/json | | Content-Type | Format de données du corps de la demande. Types pris en charge : application/json ou application/scim+json. Valeur par défaut : application/json | [Tableau 76. En-têtes de demandes] {#scim-POST-Users__entry__98} | En-tête | Description | |-|-| | Aucun | | [Tableau 77. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-POST-Users__entry__102}{#scim-POST-Users__entry-400-status-code}{#scim-POST-Users__entry-500-status-code} | Code d'état | Description | |-|-| | 201 | Réussi. La demande a été correctement traitée. | | 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. | | 409 | L'utilisateur existe déjà. Le userName paramètre doit être unique. | | 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. | [Tableau 78. Codes d'état] ### Paramètres du corps de réponse (JSON ou XML) {#scim-POST-Users__entry__112}{#scim-POST-Users__d2938e1090}{#scim-POST-Users__d2938e1115}{#scim-POST-Users__d2938e1129}{#scim-POST-Users__d2938e1140}{#scim-POST-Users__d2938e1151}{#scim-POST-Users__d2938e1163}{#scim-POST-Users__d2938e1174}{#scim-POST-Users__d2938e1185}{#scim-POST-Users__d2938e1199}{#scim-POST-Users__d2938e1213}{#scim-POST-Users__d2938e1227}{#scim-POST-Users__d2938e1239}{#scim-POST-Users__errors-SCIM-entry}{#scim-POST-Users__errors_details-SCIM-entry}{#scim-POST-Users__errors_scimType-SCIM-entry}{#scim-POST-Users__errors_schemas-SCIM-entry}{#scim-POST-Users__errors_status-SCIM-entry}{#scim-POST-Users__d2938e1250}{#scim-POST-Users__user_groups-SCIM-entry}{#scim-POST-Users__user_groups_display-SCIM-entry}{#scim-POST-Users__user_groups_type-SCIM-entry}{#scim-POST-Users__user_groups_value-SCIM-entry}{#scim-POST-Users__user_groups_ref-SCIM-entry}{#scim-POST-Users__user_id-SCIM-entry}{#scim-POST-Users__user_meta-SCIM-entry}{#scim-POST-Users__user_meta_created-SCIM-entry}{#scim-POST-Users__user_meta_lastModified-SCIM-entry}{#scim-POST-Users__user_meta_location-SCIM-entry}{#scim-POST-Users__user_meta_resourceType-SCIM-entry}{#scim-POST-Users__d2938e1390}{#scim-POST-Users__d2938e1404}{#scim-POST-Users__d2938e1415}{#scim-POST-Users__d2938e1426}{#scim-POST-Users__d2938e1437}{#scim-POST-Users__d2938e1449}{#scim-POST-Users__d2938e1463}{#scim-POST-Users__d2938e1489}{#scim-POST-Users__d2938e1500}{#scim-POST-Users__user_schemas-SCIM-entry}{#scim-POST-Users__d2938e1522}{#scim-POST-Users__d2938e1534}{#scim-POST-Users__user_userName-SCIM-ph}{#scim-POST-Users__d2938e1558} | Nom | Description | |-|-| | Actif | Marqueur indiquant si l'utilisateur associé est actif au sein de l'instance ServiceNow . Valeurs possibles : * true : l'utilisateur est actif. * false : l'utilisateur est inactif. {#scim-POST-Users__d2938e1097} Type de données : booléennes | | addresses | Détails de l'adresse postale actuelle de l'utilisateur. Type de données : objet "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" } | | adresses.pays | Nom du pays. Type de données : chaîne | | adresses.localité | Nom de la ville ou de la localité. Type de données : chaîne | | addresses.postalCode | Code postal. Type de données : chaîne | | adresses.région | État ou région. Type de données : chaîne | | adresses.rueadresse | Adresse postale complète. Il peut s'agir du numéro de maison, du nom de la rue, de la boîte postale et de l'adresse postale étendue sur plusieurs lignes. Type de données : chaîne | | adresses.type | Type d'adresse. Ne prend actuellement en charge que la page d'accueil. Type de données : chaîne | | displayName | Nom d'affichage de l'utilisateur. Cette valeur est générée automatiquement par concaténation des name champs. Type de données : chaîne | | emails | Liste des comptes de messagerie associés à l'utilisateur. Type de données : tableau d'objets "emails:" [ { "type": "String", "value": "String" } ] | | e-mails.type | Type d'e-mail de l'utilisateur. Ne prend actuellement en charge que le type de \<\< travail \>\>. Type de données : chaîne | | e-mails.valeur | Adresse e-mail de l'utilisateur. Il s'agit d'une clé unique pour l'utilisateur associé. Type de données : chaîne | | erreurs | Réponse décrivant toute erreur qui a pu se produire pendant le traitement de la demande. Type de données : objet "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" } | | errors.detail | Message d'erreur détaillé expliquant pourquoi la demande a échoué. Type de données : chaîne | | errors.scimType | Mot clé de détail de l'erreur SCIM. Type de données : chaîne | | Schémas.erreurs | URI des schémas SCIM utilisés pour traiter la réponse d'erreur. Type de données : tableau de chaînes | | erreurs.état | Code d'état HTTP de la réponse d'erreur. Type de données : chaîne | | externalId | Identificateur unique affecté à l'utilisateur par l'entité qui le provisionne. Type de données : chaîne | | groupes | Liste des groupes auxquels l'utilisateur appartient, soit par adhésion directe, soit par groupes imbriqués, soit calculée dynamiquement. Type de données : tableau d'objets "groups": [ { "display": "String", "type": "String", "value": "String", "$ref": "String" } ] | | groups.display | Nom du groupe associé. Type de données : chaîne | | groups.type | Type d'association de groupe, directe ou indirecte, par exemple. Type de données : chaîne | | Groupe.valeur | Sys_id d'un enregistrement de groupe associé. Type de données : chaîne | | groupes.$ref | URI du groupe associé. Type de données : chaîne | | id | Sys_id de l'enregistrement utilisateur associé. Type de données : chaîne | | métadonnées | Métadonnées relatives à l'utilisateur. Type de données : objet "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" } | | meta.created | Date et heure de création de l'enregistrement utilisateur. Type de données : chaîne | | meta.lastModified | Date et heure auxquelles l'enregistrement utilisateur a été modifié pour la dernière fois. Type de données : chaîne | | meta.location | L'URI de l'utilisateur en cours de récupération. Type de données : chaîne | | meta.resourceType | Type de ressource des utilisateurs SCIM. Type de données : chaîne | | nom | Informations sur le nom de l'utilisateur. Type de données : objet "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" } | | nom.nom.nom de famille | Nom de famille ou nom de famille de l'utilisateur. Type de données : chaîne | | nom.nomdonné | Prénom de l'utilisateur. Type de données : chaîne | | nom.honorificPrefix | Nom ou titre honorifique de l'utilisateur, tel que Dr., Bishop ou Baron. Type de données : chaîne | | nom.deuxième prénom | Deuxième prénom de l'utilisateur. Type de données : chaîne | | phoneNumbers | Liste des numéros de téléphone associés à l'utilisateur. Type de données : tableau d'objets "phoneNumbers": [ { "type": "String", "value": "String" } ] | | phoneNumbers.type | Type de numéro de téléphone. Valeurs possibles : * accueil * mobile * travail {#scim-POST-Users__d2938e1468} Type de données : chaîne | | phoneNumbers.value | Numéro de téléphone de l'utilisateur. Type de données : chaîne | | preferredLanguage | Langue parlée et écrite préférée de l'utilisateur. Type de données : chaîne | | Schémas | Liste des URI des schémas d'utilisateur SCIM utilisés pour traiter la demande. Type de données : tableau de chaînes | | fuseau horaire | Fuseau horaire de l'utilisateur. Type de données : chaîne | | Titre | Titre de l'utilisateur, par exemple PDG ou Président. Type de données : chaîne | | userName | Nom d'utilisateur unique pour l'utilisateur associé. Type de données : chaîne | | Type d'utilisateur | Type d'utilisateur. Cette valeur est utilisée pour identifier la relation entre l'organisation et l'utilisateur. Il peut s'agir de n'importe quelle valeur, mais les valeurs typiques peuvent inclure : * Prestataire * Employé * Interne * Intérimaire * Externe * Inconnu {#scim-POST-Users__d2938e1562} Type de données : chaîne | [ ] ### demande cURL à l'utilisateur POST Cet exemple montre comment PUBLIER l'utilisateur Jack Sparrow dans la table Utilisateur \[sys_user\]. curl -X POST \ https://instance-servicenow.com/api/now/scim/Users \ -d '{ "schemas": [ "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User", "urn:ietf:params:scim:schemas:core:2.0:User" ], "externalId": "123456", "userName": "jack.sparrow", "name": { "familyName": "Sparrow", "givenName": "Jack" }, "title": "Senior Developer", "preferredLanguage": "en", "timezone": "ET", "active": true, "emails": [ { "value": "jack.sparrow@abc.com", "display": null, "type": "work", "primary": true } ], "phoneNumbers": [ { "value": "9977553312", "type": "mobile", "primary": true } ] }' Réponse {"schemas": [ "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User", "urn:ietf:params:scim:schemas:core:2.0:User" ], "id":"d6287d7b1bbe3010593876a61a4bcbc3", "externalId":"123456", "meta":{ "resourceType":"User", "created":"2021-10-01T16:46:48Z", "lastModified":"2021-10-01T16:46:48Z", "location":"https://instance-servicenow.com/api/now/scim/Users/d6287d7b1bbe3010593876a61a4bcbc3" }, "userName":"jack.sparrow", "name":{ "familyName":"Sparrow", "givenName":"Jack" }, "displayName":"Jack Sparrow", "title":"Senior Developer", "preferredLanguage":"en", "timezone":"ET", "active":true, "emails":[ { "value":"jack.sparrow@abc.com", "type":"work" } ], "phoneNumbers":[ { "value":"9977553312", "type":"mobile" } ] } ## SCIM - PUT /scim/Users/{user_id} {#ariaid-title13} Met à jour l'enregistrement utilisateur spécifié dans la table Utilisateur \[sys_user\] d'une ServiceNow instance utilisant le protocole SCIM (System for Cross-domain Identity Management). ### Format d'URL URL versionnée : /api/now/{api_version}/scim/Users/{user_id} URL par défaut : /api/now/scim/Users/{user_id} ### Paramètres de demande pris en charge {#scim-PUT-Users-user_id__entry__2}{#scim-PUT-Users-user_id__version-RESTAPI} | Nom | Description | |-|-| | api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne | | user_id | Sys_id de l'enregistrement utilisateur à mettre à jour. | [Tableau 79. Paramètres de chemin d'accès] {#scim-PUT-Users-user_id__entry__8}{#scim-PUT-Users-user_id__attributes-SCIM-entry}{#scim-PUT-Users-user_id__excludedAttributes-SCIM-entry} | Nom | Description | |-|-| | attributs | Liste des champs séparés par des virgules à envoyer dans la réponse. Aucun autre champ n'est renvoyé. Ne peut pas être utilisé avec le excludedAttributes paramètre. Type de données : chaîne Par défaut : renvoie tous les champs sauf s'il excludedAttributes est spécifié. | | Attributs exclus | Liste de champs séparés par des virgules à exclure des enregistrements renvoyés dans la réponse. Tous les autres champs sont renvoyés. Ne peut pas être utilisé avec le attributes paramètre. Type de données : chaîne Par défaut : n'excluez aucun champ. | [Tableau 80. Paramètres de requête] {#scim-PUT-Users-user_id__entry__14}{#scim-PUT-Users-user_id__user_active-SCIM-entry}{#scim-PUT-Users-user_id__user_addresses-SCIM-entry}{#scim-PUT-Users-user_id__user_addresses_country-SCIM-entry}{#scim-PUT-Users-user_id__user_addresses_locality-SCIM-entry}{#scim-PUT-Users-user_id__user_addresses_postalCode-SCIM-entry}{#scim-PUT-Users-user_id__user_addresses_region-SCIM-entry}{#scim-PUT-Users-user_id__user_addresses_streetAddress-SCIM-entry}{#scim-PUT-Users-user_id__user_addresses_type-SCIM-entry}{#scim-PUT-Users-user_id__user_displayName-SCIM-entry}{#scim-PUT-Users-user_id__user_emails-SCIM-entry}{#scim-PUT-Users-user_id__user_emails_type-SCIM-entry}{#scim-PUT-Users-user_id__user_emails_value-SCIM-entry}{#scim-PUT-Users-user_id__user_emails_externalId-SCIM-entry}{#scim-PUT-Users-user_id__user_name-SCIM-entry}{#scim-PUT-Users-user_id__user_name_familyName-SCIM-entry}{#scim-PUT-Users-user_id__user_name_givenName-SCIM-entry}{#scim-PUT-Users-user_id__user_name_honorificPrefix-SCIM-entry}{#scim-PUT-Users-user_id__user_name_middle-SCIM-entry}{#scim-PUT-Users-user_id__user_phoneNumbers-SCIM-entry}{#scim-PUT-Users-user_id__user_phoneNumbers_type-SCIM-entry}{#scim-PUT-Users-user_id__user_phoneNumbers_value-SCIM-entry}{#scim-PUT-Users-user_id__user_preferredLanguage-SCIM-entry}{#scim-PUT-Users-user_id__user_timezone-SCIM-entry}{#scim-PUT-Users-user_id__user_title-SCIM-entry}{#scim-PUT-Users-user_id__user_userType-SCIM-entry}{#scim-PUT-Users-user_id__user_employeeNumber-SCIM-entry}{#scim-PUT-Users-user_id__user_gender-SCIM-entry} | Nom | Description | |-|-| | Actif | Marqueur indiquant si l'utilisateur associé est actif au sein de l'instance ServiceNow . Valeurs possibles : * true : l'utilisateur est actif. * false : l'utilisateur est inactif. {#scim-PUT-Users-user_id__ul_glm_qkj_grb} Type de données : booléennes | | addresses | Détails de l'adresse postale actuelle de l'utilisateur. Type de données : objet "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" } | | adresses.pays | Nom du pays. Type de données : chaîne | | adresses.localité | Nom de la ville ou de la localité. Type de données : chaîne | | addresses.postalCode | Code postal. Type de données : chaîne | | adresses.région | État ou région. Type de données : chaîne | | adresses.rueadresse | Adresse postale complète. Il peut s'agir du numéro de maison, du nom de la rue, de la boîte postale et de l'adresse postale étendue sur plusieurs lignes. Type de données : chaîne | | adresses.type | Type d'adresse. Ne prend actuellement en charge que la page d'accueil. Type de données : chaîne | | displayName | Nom d'affichage de l'utilisateur. Cette valeur est générée automatiquement par concaténation des name champs. Type de données : chaîne | | emails | Liste des comptes de messagerie associés à l'utilisateur. Type de données : tableau d'objets "emails:" [ { "type": "String", "value": "String" } ] | | e-mails.type | Type d'e-mail de l'utilisateur. Ne prend actuellement en charge que le type de \<\< travail \>\>. Type de données : chaîne | | e-mails.valeur | Adresse e-mail de l'utilisateur. Il s'agit d'une clé unique pour l'utilisateur associé. Type de données : chaîne | | externalId | Identificateur unique affecté à l'utilisateur par l'entité qui le provisionne. Type de données : chaîne | | nom | Informations sur le nom de l'utilisateur. Type de données : objet "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" } | | nom.nom.nom de famille | Nom de famille ou nom de famille de l'utilisateur. Type de données : chaîne | | nom.nomdonné | Prénom de l'utilisateur. Type de données : chaîne | | nom.honorificPrefix | Nom ou titre honorifique de l'utilisateur, tel que Dr., Bishop ou Baron. Type de données : chaîne | | nom.deuxième prénom | Deuxième prénom de l'utilisateur. Type de données : chaîne | | phoneNumbers | Liste des numéros de téléphone associés à l'utilisateur. Type de données : tableau d'objets "phoneNumbers": [ { "type": "String", "value": "String" } ] | | phoneNumbers.type | Type de numéro de téléphone. Valeurs possibles : * accueil * mobile * travail {#scim-PUT-Users-user_id__ul_idb_brj_grb} Type de données : chaîne | | phoneNumbers.value | Numéro de téléphone de l'utilisateur. Type de données : chaîne | | preferredLanguage | Langue parlée et écrite préférée de l'utilisateur. Type de données : chaîne | | fuseau horaire | Fuseau horaire de l'utilisateur. Type de données : chaîne | | Titre | Titre de l'utilisateur, par exemple PDG ou Président. Type de données : chaîne | | userName | Requis. Nom d'utilisateur unique pour l'utilisateur associé. Type de données : chaîne | | Type d'utilisateur | Type d'utilisateur. Cette valeur est utilisée pour identifier la relation entre l'organisation et l'utilisateur. Il peut s'agir de n'importe quelle valeur, mais les valeurs typiques peuvent inclure : * Prestataire * Employé * Interne * Intérimaire * Externe * Inconnu {#scim-PUT-Users-user_id__ul_kdr_nwz_nrb} Type de données : chaîne | | Schéma étendu | | | company | Détails sur la société associée à l'utilisateur. Type de données : objet "company": { "value": "String" } | | entreprise.valeur | Requis si l'entreprise est incluse dans la publication. Sys_id de l'enregistrement de société. Type de données : chaîne | | Centre de coûts | Détails sur le centre de coûts associé à l'utilisateur. Type de données : objet "costCenter": { "value": "String" } | | centre-coûts.valeur | Requis si CostCenter est inclus dans la publication. Sys_id de l'enregistrement de centre de coûts. Type de données : chaîne | | département | Détails sur le département associé à l'utilisateur. Type de données : objet "department": { "value": "String" } | | valeur.département | Obligatoire si le département est inclus dans la publication. Sys_id de l'enregistrement du département. Type de données : chaîne | | employeeNumber | Numéro d'employé numérique ou alphanumérique. Type de données : chaîne | | sexe | Sexe de l'utilisateur, par exemple homme ou femme. Type de données : chaîne | | emplacement | Détails sur l'emplacement associé de l'utilisateur. Type de données : objet "location": { "value": "String" } | | Emplacement.valeur | Requis si l'emplacement est inclus dans la publication. Sys_id de l'enregistrement de l'emplacement. Type de données : chaîne | | responsable | Détails sur le gestionnaire associé à l'utilisateur. Type de données : objet "manager": { "value": "String" } | | gestionnaire.valeur | Requis si le gestionnaire est inclus dans la publication. Sys_id de l'enregistrement du gestionnaire. Type de données : chaîne | [Tableau 81. Paramètres du corps de la demande (JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-PUT-Users-user_id__entry__94}{#scim-PUT-Users-user_id__Accept-SCIM-entry}{#scim-PUT-Users-user_id__Content_Type-SCIM-entry} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/scim+json. Valeur par défaut : application/json | | Content-Type | Format de données du corps de la demande. Types pris en charge : application/json ou application/scim+json. Valeur par défaut : application/json | [Tableau 82. En-têtes de demandes] {#scim-PUT-Users-user_id__entry__100} | En-tête | Description | |-|-| | Aucun | | [Tableau 83. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-PUT-Users-user_id__entry__104}{#scim-PUT-Users-user_id__entry-200-status-code}{#scim-PUT-Users-user_id__entry-404-status-code}{#scim-PUT-Users-user_id__entry-500-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 404 | Introuvable. L'élément demandé est introuvable. | | 409 | L'utilisateur existe déjà. Le userName paramètre doit être unique. | | 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. | [Tableau 84. Codes d'état] ### Paramètres de corps de réponse (JSON) {#scim-PUT-Users-user_id__table_mjy_k1l_grb__entry__2}{#scim-PUT-Users-user_id__d2938e1090}{#scim-PUT-Users-user_id__d2938e1115}{#scim-PUT-Users-user_id__d2938e1129}{#scim-PUT-Users-user_id__d2938e1140}{#scim-PUT-Users-user_id__d2938e1151}{#scim-PUT-Users-user_id__d2938e1163}{#scim-PUT-Users-user_id__d2938e1174}{#scim-PUT-Users-user_id__d2938e1185}{#scim-PUT-Users-user_id__d2938e1199}{#scim-PUT-Users-user_id__d2938e1213}{#scim-PUT-Users-user_id__d2938e1227}{#scim-PUT-Users-user_id__d2938e1239}{#scim-PUT-Users-user_id__errors-SCIM-entry}{#scim-PUT-Users-user_id__errors_details-SCIM-entry}{#scim-PUT-Users-user_id__errors_scimType-SCIM-entry}{#scim-PUT-Users-user_id__errors_schemas-SCIM-entry}{#scim-PUT-Users-user_id__errors_status-SCIM-entry}{#scim-PUT-Users-user_id__d2938e1250}{#scim-PUT-Users-user_id__user_groups-SCIM-entry}{#scim-PUT-Users-user_id__user_groups_display-SCIM-entry}{#scim-PUT-Users-user_id__user_groups_type-SCIM-entry}{#scim-PUT-Users-user_id__user_groups_value-SCIM-entry}{#scim-PUT-Users-user_id__user_groups_ref-SCIM-entry}{#scim-PUT-Users-user_id__user_id-SCIM-entry}{#scim-PUT-Users-user_id__user_meta-SCIM-entry}{#scim-PUT-Users-user_id__user_meta_created-SCIM-entry}{#scim-PUT-Users-user_id__user_meta_lastModified-SCIM-entry}{#scim-PUT-Users-user_id__user_meta_location-SCIM-entry}{#scim-PUT-Users-user_id__user_meta_resourceType-SCIM-entry}{#scim-PUT-Users-user_id__d2938e1390}{#scim-PUT-Users-user_id__d2938e1404}{#scim-PUT-Users-user_id__d2938e1415}{#scim-PUT-Users-user_id__d2938e1426}{#scim-PUT-Users-user_id__d2938e1437}{#scim-PUT-Users-user_id__d2938e1449}{#scim-PUT-Users-user_id__d2938e1463}{#scim-PUT-Users-user_id__d2938e1489}{#scim-PUT-Users-user_id__d2938e1500}{#scim-PUT-Users-user_id__user_schemas-SCIM-entry}{#scim-PUT-Users-user_id__d2938e1522}{#scim-PUT-Users-user_id__d2938e1534}{#scim-PUT-Users-user_id__user_userName-SCIM-ph}{#scim-PUT-Users-user_id__d2938e1558} | Nom | Description | |-|-| | Actif | Marqueur indiquant si l'utilisateur associé est actif au sein de l'instance ServiceNow . Valeurs possibles : * true : l'utilisateur est actif. * false : l'utilisateur est inactif. {#scim-PUT-Users-user_id__d2938e1097} Type de données : booléennes | | addresses | Détails de l'adresse postale actuelle de l'utilisateur. Type de données : objet "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" } | | adresses.pays | Nom du pays. Type de données : chaîne | | adresses.localité | Nom de la ville ou de la localité. Type de données : chaîne | | addresses.postalCode | Code postal. Type de données : chaîne | | adresses.région | État ou région. Type de données : chaîne | | adresses.rueadresse | Adresse postale complète. Il peut s'agir du numéro de maison, du nom de la rue, de la boîte postale et de l'adresse postale étendue sur plusieurs lignes. Type de données : chaîne | | adresses.type | Type d'adresse. Ne prend actuellement en charge que la page d'accueil. Type de données : chaîne | | displayName | Nom d'affichage de l'utilisateur. Cette valeur est générée automatiquement par concaténation des name champs. Type de données : chaîne | | emails | Liste des comptes de messagerie associés à l'utilisateur. Type de données : tableau d'objets "emails:" [ { "type": "String", "value": "String" } ] | | e-mails.type | Type d'e-mail de l'utilisateur. Ne prend actuellement en charge que le type de \<\< travail \>\>. Type de données : chaîne | | e-mails.valeur | Adresse e-mail de l'utilisateur. Il s'agit d'une clé unique pour l'utilisateur associé. Type de données : chaîne | | erreurs | Réponse décrivant toute erreur qui a pu se produire pendant le traitement de la demande. Type de données : objet "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" } | | errors.detail | Message d'erreur détaillé expliquant pourquoi la demande a échoué. Type de données : chaîne | | errors.scimType | Mot clé de détail de l'erreur SCIM. Type de données : chaîne | | Schémas.erreurs | URI des schémas SCIM utilisés pour traiter la réponse d'erreur. Type de données : tableau de chaînes | | erreurs.état | Code d'état HTTP de la réponse d'erreur. Type de données : chaîne | | externalId | Identificateur unique affecté à l'utilisateur par l'entité qui le provisionne. Type de données : chaîne | | groupes | Liste des groupes auxquels l'utilisateur appartient, soit par adhésion directe, soit par groupes imbriqués, soit calculée dynamiquement. Type de données : tableau d'objets "groups": [ { "display": "String", "type": "String", "value": "String", "$ref": "String" } ] | | groups.display | Nom du groupe associé. Type de données : chaîne | | groups.type | Type d'association de groupe, directe ou indirecte, par exemple. Type de données : chaîne | | Groupe.valeur | Sys_id d'un enregistrement de groupe associé. Type de données : chaîne | | groupes.$ref | URI du groupe associé. Type de données : chaîne | | id | Sys_id de l'enregistrement utilisateur associé. Type de données : chaîne | | métadonnées | Métadonnées relatives à l'utilisateur. Type de données : objet "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" } | | meta.created | Date et heure de création de l'enregistrement utilisateur. Type de données : chaîne | | meta.lastModified | Date et heure auxquelles l'enregistrement utilisateur a été modifié pour la dernière fois. Type de données : chaîne | | meta.location | L'URI de l'utilisateur en cours de récupération. Type de données : chaîne | | meta.resourceType | Type de ressource des utilisateurs SCIM. Type de données : chaîne | | nom | Informations sur le nom de l'utilisateur. Type de données : objet "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" } | | nom.nom.nom de famille | Nom de famille ou nom de famille de l'utilisateur. Type de données : chaîne | | nom.nomdonné | Prénom de l'utilisateur. Type de données : chaîne | | nom.honorificPrefix | Nom ou titre honorifique de l'utilisateur, tel que Dr., Bishop ou Baron. Type de données : chaîne | | nom.deuxième prénom | Deuxième prénom de l'utilisateur. Type de données : chaîne | | phoneNumbers | Liste des numéros de téléphone associés à l'utilisateur. Type de données : tableau d'objets "phoneNumbers": [ { "type": "String", "value": "String" } ] | | phoneNumbers.type | Type de numéro de téléphone. Valeurs possibles : * accueil * mobile * travail {#scim-PUT-Users-user_id__d2938e1468} Type de données : chaîne | | phoneNumbers.value | Numéro de téléphone de l'utilisateur. Type de données : chaîne | | preferredLanguage | Langue parlée et écrite préférée de l'utilisateur. Type de données : chaîne | | Schémas | Liste des URI des schémas d'utilisateur SCIM utilisés pour traiter la demande. Type de données : tableau de chaînes | | fuseau horaire | Fuseau horaire de l'utilisateur. Type de données : chaîne | | Titre | Titre de l'utilisateur, par exemple PDG ou Président. Type de données : chaîne | | userName | Nom d'utilisateur unique pour l'utilisateur associé. Type de données : chaîne | | Type d'utilisateur | Type d'utilisateur. Cette valeur est utilisée pour identifier la relation entre l'organisation et l'utilisateur. Il peut s'agir de n'importe quelle valeur, mais les valeurs typiques peuvent inclure : * Prestataire * Employé * Interne * Intérimaire * Externe * Inconnu {#scim-PUT-Users-user_id__d2938e1562} Type de données : chaîne | [ ] {#scim-PUT-Users-user_id__table_mjy_k1l_grb} ### Paramètres d'extension retournés {#scim-PUT-Users-user_id__section_vb2_yny_jlb} {#scim-PUT-Users-user_id__id_hmw_fjk_grb__entry__2}{#scim-PUT-Users-user_id__user_company-SCIM-entry}{#scim-PUT-Users-user_id__user_company_display-SCIM-entry}{#scim-PUT-Users-user_id__user_company_value-SCIM-ph}{#scim-PUT-Users-user_id__user_company_ref-SCIM-entry}{#scim-PUT-Users-user_id__user_costCenter-SCIM-entry}{#scim-PUT-Users-user_id__user_costCenter_display-SCIM-entry}{#scim-PUT-Users-user_id__user_costCenter_value-SCIM-ph}{#scim-PUT-Users-user_id__user_costCenter_ref-SCIM-entry}{#scim-PUT-Users-user_id__user_department-SCIM-entry}{#scim-PUT-Users-user_id__user_department_display-SCIM-entry}{#scim-PUT-Users-user_id__user_department_value-SCIM-ph}{#scim-PUT-Users-user_id__user_department_ref-SCIM-entry}{#scim-PUT-Users-user_id__d2938e1768}{#scim-PUT-Users-user_id__d2938e1779}{#scim-PUT-Users-user_id__user_location-SCIM-entry}{#scim-PUT-Users-user_id__user_location_display-SCIM-entry}{#scim-PUT-Users-user_id__user_location_value-SCIM-ph}{#scim-PUT-Users-user_id__user_location_ref-SCIM-entry}{#scim-PUT-Users-user_id__user_manager-SCIM-entry}{#scim-PUT-Users-user_id__user_manager_display-SCIM-entry}{#scim-PUT-Users-user_id__user_manager_value-SCIM-ph}{#scim-PUT-Users-user_id__user_manager_ref-SCIM-entry} | Nom | Description | |-|-| | company | Détails sur la société associée à l'utilisateur. Type de données : objet "company": { "display": "String", "value": "String", "$ref": "String" } | | entreprise.display | Nom de la société. Type de données : chaîne | | entreprise.valeur | Sys_id de l'enregistrement de société. Type de données : chaîne | | entreprise.$ref | URI de référence pour la société. Type de données : chaîne | | Centre de coûts | Détails sur le centre de coûts associé à l'utilisateur. Type de données : objet "costCenter": { "display": "String", "value": "String", "$ref": "String" } | | centredecoûts.affichage | Nom du centre de coûts. Type de données : chaîne | | centre-coûts.valeur | Sys_id de l'enregistrement de centre de coûts. Type de données : chaîne | | centredecoûts.$ref | URI de référence pour le centre de coûts. Type de données : chaîne | | département | Détails sur le département associé à l'utilisateur. Type de données : objet "department": { "display": "String", "value": "String", "$ref": "String" } | | department.display | Nom du département. Type de données : chaîne | | valeur.département | Sys_id de l'enregistrement du département. Type de données : chaîne | | département.$ref | URI de référence pour le département. Type de données : chaîne | | employeeNumber | Numéro d'employé numérique ou alphanumérique. Type de données : chaîne | | sexe | Sexe de l'utilisateur, par exemple homme ou femme. Type de données : chaîne | | emplacement | Détails sur l'emplacement associé de l'utilisateur. Type de données : objet "location": { "display": "String", "value": "String", "$ref": "String" } | | Emplacement.Affichage | Nom de l'emplacement. Type de données : chaîne | | Emplacement.valeur | Sys_id de l'enregistrement de l'emplacement. Type de données : chaîne | | l'emplacement.$ref | URI de référence pour l'emplacement. Type de données : chaîne | | responsable | Détails sur le gestionnaire associé à l'utilisateur. Type de données : objet "manager": { "display": "String", "value": "String", "$ref": "String" } | | manager.display | Nom du gestionnaire. Type de données : chaîne | | gestionnaire.valeur | Sys_id de l'enregistrement du gestionnaire. Type de données : chaîne | | gestionnaire.$ref | URI de référence pour le gestionnaire. Type de données : chaîne | [ ] {#scim-PUT-Users-user_id__id_hmw_fjk_grb} ### Demande cURL pour mettre à jour les informations de l'utilisateur à l'aide de PUT Cet exemple montre comment mettre à jour les informations d'un utilisateur existant à l'aide du point de terminaison PUT. curl -X PUT \ https://instance-servicenow.com/api/now/scim/Users/cdfef423e0423010f8778ac6d674f5ae \ -d '{ "schemas": [ "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User", "urn:ietf:params:scim:schemas:core:2.0:User" ], "externalId": "123457", "userName": "john.Doe", "name": { "familyName": "Doe", "givenName": "John" }, "title": "Sir", "preferredLanguage": "en", "timezone": "ET", "active": true, "emails": [ { "value": "john.doe@abc.com", "display": null, "type": "work", "primary": true } ], "phoneNumbers": [ { "value": "9977553312", "type": "mobile", "primary": true } ], "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User": { "gender": "Male", "employeeNumber" : "13453", "location" : { "value" : "0002c0a93790200044e0bfc8bcbe5df5" }, "company" : { "value" : "81fd65ecac1d55eb42a426568fc87a63" }, "costCenter" : { "value" : "7fb1cc99c0a80a6d30c04574d14c0acf" }, "department" : { "value":"221db0edc611228401760aec06c9d929" } } }' Réponse { "schemas": [ "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User", "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "b7c5015f778330102e8cc5179e5a9992", "externalId": "123457", "meta": { "resourceType": "User", "created": "2021-10-12T10:05:32Z", "lastModified": "2021-10-12T10:08:04Z", "location": "http://instance-servicenow.com/api/now/scim/Users/b7c5015f778330102e8cc5179e5a9992" }, "userName": "john.doe", "name": { "familyName": "Doe", "givenName": "John" }, "displayName": "John Doe", "title": "Sir", "preferredLanguage": "en", "timezone": "ET", "active": true, "emails": [ { "value": "tony.stark@abc.com", "type": "work" } ], "phoneNumbers": [ { "value": "9977553312", "type": "mobile" } ], "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User": { "employeeNumber": "13453", "gender": "Male", "costCenter": { "value": "7fb1cc99c0a80a6d30c04574d14c0acf", "name": "Sales", "$ref": "http://instance-servicenow.com/api/now/scim/CostCenters/7fb1cc99c0a80a6d30c04574d14c0acf" }, "company": { "value": "81fd65ecac1d55eb42a426568fc87a63", "name": "ACME Japan", "$ref": "http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63" }, "department": { "value": "221db0edc611228401760aec06c9d929", "name": "Sales", "$ref": "http://instance-servicenow.com/api/now/scim/Departments/221db0edc611228401760aec06c9d929" }, "manager": { "value": "7027fda8773230102e8cc5179e5a99ea", "displayName": "Jack Sparrow", "$ref": "http://instance-servicenow.com/api/now/scim/Users/7027fda8773230102e8cc5179e5a99ea" }, "location": { "value": "0002c0a93790200044e0bfc8bcbe5df5", "name": "2-10-1 Yurakucho, Chiyoda-ku, Tokyo", "$ref": "http://instance-servicenow.com/api/now/scim/Locations/0002c0a93790200044e0bfc8bcbe5df5" } } } ## SCIM : GET /scim/ResourceTypes {#ariaid-title14} Récupère des informations sur tous les types de ressources SCIM (System for Cross-domain Identity Management) pris en charge par l'instance associée ServiceNow . Il s'agit d'un point de terminaison public dont l'accès ne nécessite aucun rôle. ### Format d'URL URL versionnée : /api/now/{api_version}/scim/ResourceTypes URL par défaut : /api/now/scim/ResourceTypes ### Paramètres de demande pris en charge {#scim-GET-ResourceTypes__entry__2}{#scim-GET-ResourceTypes__version-RESTAPI} | Nom | Description | |-|-| | api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne | [Tableau 85. Paramètres de chemin d'accès] {#scim-GET-ResourceTypes__entry__6} | Nom | Description | |-|-| | Aucun | | [Tableau 86. Paramètres de requête] {#scim-GET-ResourceTypes__entry__10} | Nom | Description | |-|-| | Aucun | | [Tableau 87. Paramètres du corps de la demande (JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-GET-ResourceTypes__entry__14}{#scim-GET-ResourceTypes__Accept-SCIM-entry} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/scim+json. Valeur par défaut : application/json | [Tableau 88. En-têtes de demandes] {#scim-GET-ResourceTypes__entry__18} | En-tête | Description | |-|-| | Aucun | | [Tableau 89. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-GET-ResourceTypes__entry__22}{#scim-GET-ResourceTypes__entry-200-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | [Tableau 90. Codes d'état] ### Paramètres de corps de réponse (JSON) {#scim-GET-ResourceTypes__id_avz_rp3_3rb__entry__2}{#scim-GET-ResourceTypes__itemsPerPage-SCIM-entry}{#scim-GET-ResourceTypes__description-SCIM-entry}{#scim-GET-ResourceTypes__endpoint-SCIM-entry}{#scim-GET-ResourceTypes__id-SCIM-entry}{#scim-GET-ResourceTypes__meta-SCIM-entry}{#scim-GET-ResourceTypes__meta_location-SCIM-entry}{#scim-GET-ResourceTypes__meta_resourceType-SCIM-entry}{#scim-GET-ResourceTypes__name-SCIM-entry}{#scim-GET-ResourceTypes__schema-SCIM-entry}{#scim-GET-ResourceTypes__schemas-SCIM-entry}{#scim-GET-ResourceTypes__schemaExtensions-SCIM-entry}{#scim-GET-ResourceTypes__schemaExtensions_required-SCIM-entry}{#scim-GET-ResourceTypes__schemaExtensions_schema-SCIM-entry}{#scim-GET-ResourceTypes__schemas2-SCIM-entry}{#scim-GET-ResourceTypes__startIndex-SCIM-entry}{#scim-GET-ResourceTypes__totalResults-SCIM-entry} | Nom | Description | |-|-| | itemsPerPage | Nombre d'enregistrements renvoyés dans les résultats renvoyés. Type de données : nombre | | Ressources | Liste des types de ressources disponibles. Type de données : tableau d'objets "Resources": [ { "description": "String", "endpoint": "String", "id": "String", "meta": {Object}, "name": "String", "schema": "String" "schemas": [Array], "schemaExtensions": [Array] } ] | | Resources.description | Brève description du type de ressource. Type de données : chaîne | | Ressources.point de terminaison | Nom du point de terminaison adressable HTTP par rapport à l'URL de base du fournisseur de service, par exemple \<\< Utilisateurs \>\>. Type de données : chaîne | | Resources.id | Identificateur unique de la ressource. Utilisez cet attribut lors de l'appel du point de terminaison GET /scim/ResourceType/{resource_id}. Type de données : chaîne | | Ressources.meta | Informations décrivant plus en détail la ressource associée. Type de données : objet "metadata": { "location": "String", "resourceType": "String" } | | Ressources.meta.location | URI du type de ressource associé sur l'instance associée ServiceNow . Type de données : chaîne | | Resources.meta.resourceType | Toujours \<\< ResourceType \>\>. Type de données : chaîne | | Resources.name | Nom du type de ressource, par exemple Utilisateur ou Groupe. Type de données : chaîne | | Ressources.schéma | URI de schéma primaire/de base du type de ressource. Par exemple : `<< urn :ietf :params :scim :schemas :core :2.0 :User >>.` Type de données : chaîne | | Resources.schemas | Schéma utilisé pour traiter la demande `/ResourceType` . Par exemple : `<< urn :ietf :params :scim :schemas :core :2.0 :ResourceType >>.` Type de données : chaîne | | Resources.schemaExtensions | Liste des extensions de schéma qui s'appliquent au type de ressource associé. Par exemple : `<< urn :ietf :params :scim :schemas :extension : servicenow :2.0 :User >>.` Type de données : tableau d'objets "schemaExtensions": { "required": Boolean, "schema": "String" } | | Ressources.schemaExtensions.requises | Marqueur indiquant si l'extension de schéma est requise pour le type de ressource. Valeurs possibles : * vrai : une ressource de ce type doit inclure cette extension de schéma ainsi que tous les attributs déclarés comme requis dans cette extension de schéma. * false : une ressource de ce type peut omettre cette extension de schéma. {#scim-GET-ResourceTypes__ul_nng_2p3_3rb} Type de données : booléennes | | Resources.schemaExtensions.schema | URI d'un schéma étendu. Par exemple : `<< urn :ietf :params :scim :schemas :extension :servicenow : 2.0 :User >>.` Type de données : chaîne | | Schémas | Schéma utilisé pour traiter la réponse de liste à la demande. Par exemple : `<< urn :ietf :params :scim :api :messages :2.0 :ListResponse >>` Type de données : chaîne | | startIndex | Index de base un dans la table Ressource dans laquelle les enregistrements ont été récupérés. Type de données : chaîne | | totalResults | Nombre total d'enregistrements qui correspondent à la demande. Type de données : nombre | [ ] {#scim-GET-ResourceTypes__id_avz_rp3_3rb} ### Demande cURL L'exemple suivant montre comment obtenir les types de ressources SCIM pris en charge par une ServiceNow instance. curl "https://instance-servicenow.com/api/now/scim/ResourceTypes \ --request GET \ --header "Accept:application/scim+json" \ Réponse { "schemas":[ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ], "totalResults":6, "Resources":[ { "schemas":[ "urn:ietf:params:scim:schemas:core:2.0:ResourceType" ], "id":"User", "name":"User", "description":"User Account", "endpoint":"/Users", "schema":"urn:ietf:params:scim:schemas:core:2.0:User", "schemaExtensions":[ { "schema":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User", "required":false }, { "schema":"urn:ietf:params:scim:schemas:extension:servicenow:2.0:User", "required":false } ], "meta":{ "resourceType":"ResourceType", "location":"https://instance-servicenow.com/api/now/scim/ResourceTypes/User" } }, { "schemas":[ "urn:ietf:params:scim:schemas:core:2.0:ResourceType" ], "id":"Group", "name":"Group", "description":"Group", "endpoint":"/Groups", "schema":"urn:ietf:params:scim:schemas:core:2.0:Group", "meta":{ "resourceType":"ResourceType", "location":"https://instance-servicenow.service-now.com/api/now/scim/ResourceTypes/Group" } }, { "schemas":[ "urn:ietf:params:scim:schemas:core:2.0:ResourceType" ], "id":"Company", "name":"Company", "description":"Company", "endpoint":"/Companies", "schema":"urn:ietf:params:scim:schemas:custom:servicenow:2.0:Company", "meta":{ "resourceType":"ResourceType", "location":"https://instance-servicenow.com/api/now/scim/ResourceTypes/Company" } }, { "schemas":[ "urn:ietf:params:scim:schemas:core:2.0:ResourceType" ], "id":"Department", "name":"Department", "description":"Department", "endpoint":"/Departments", "schema":"urn:ietf:params:scim:schemas:custom:servicenow:2.0:Department", "meta":{ "resourceType":"ResourceType", "location":"https://instance-servicenow.com/api/now/scim/ResourceTypes/Department" } }, { "schemas":[ "urn:ietf:params:scim:schemas:core:2.0:ResourceType" ], "id":"CostCenter", "name":"CostCenter", "description":"CostCenter", "endpoint":"/CostCenters", "schema":"urn:ietf:params:scim:schemas:custom:servicenow:2.0:CostCenter", "meta":{ "resourceType":"ResourceType", "location":"https://instance-servicenow.com/api/now/scim/ResourceTypes/CostCenter" } }, { "schemas":[ "urn:ietf:params:scim:schemas:core:2.0:ResourceType" ], "id":"Location", "name":"Location", "description":"Location", "endpoint":"/Locations", "schema":"urn:ietf:params:scim:schemas:custom:servicenow:2.0:Location", "meta":{ "resourceType":"ResourceType", "location":"https://instance-servicenow.com/api/now/scim/ResourceTypes/Location" } } ], "startIndex":1, "itemsPerPage":6 } ## SCIM : GET /scim/ResourceTypes/{ResourceName} {#ariaid-title15} Récupère des informations sur le type de ressource SCIM (System for Cross-domain Identity Management) spécifié. Il s'agit d'un point de terminaison public dont l'accès ne nécessite aucun rôle. ### Format d'URL URL versionnée : /api/now/{api_version}/scim/ResourceTypes/{ResourceName} URL par défaut : /api/now/scim/ResourceTypes/{ResourceName} ### Paramètres de demande pris en charge {#scim-GET-ResourceTypes-ResourceName__entry__2}{#scim-GET-ResourceTypes-ResourceName__version-RESTAPI} | Nom | Description | |-|-| | api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne | | Nom de ressource | ID unique du type de ressource à récupérer. Valeurs valides : * Société * CostCenter * Département * Groupe * Emplacement * Utilisateur {#scim-GET-ResourceTypes-ResourceName__ul_vml_qr3_3rb} Type de données : chaîne | [Tableau 91. Paramètres de chemin d'accès] {#scim-GET-ResourceTypes-ResourceName__entry__8} | Nom | Description | |-|-| | Aucun | | [Tableau 92. Paramètres de requête] {#scim-GET-ResourceTypes-ResourceName__entry__12} | Nom | Description | |-|-| | Aucun | | [Tableau 93. Paramètres du corps de la demande (JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-GET-ResourceTypes-ResourceName__entry__16}{#scim-GET-ResourceTypes-ResourceName__Accept-SCIM-entry} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/scim+json. Valeur par défaut : application/json | [Tableau 94. En-têtes de demandes] {#scim-GET-ResourceTypes-ResourceName__entry__20} | En-tête | Description | |-|-| | Aucun | | [Tableau 95. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-GET-ResourceTypes-ResourceName__entry__24}{#scim-GET-ResourceTypes-ResourceName__entry-200-status-code}{#scim-GET-ResourceTypes-ResourceName__entry-404-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 404 | Introuvable. L'élément demandé est introuvable. | [Tableau 96. Codes d'état] ### Paramètres de corps de réponse (JSON) {#scim-GET-ResourceTypes-ResourceName__id_avz_rp3_3rb__entry__2} | Nom | Description | |-|-| | description | Brève description du type de ressource. Type de données : chaîne | | endpoint | Nom du point de terminaison adressable HTTP par rapport à l'URL de base du fournisseur de service, par exemple \<\< Sociétés \>\>. Type de données : chaîne | | id | Identificateur unique de la ressource. Utilisez cet attribut lors de l'appel du point de terminaison GET /scim/ResourceType/{resource_id}. Type de données : chaîne | | métadonnées | Informations décrivant plus en détail la ressource associée. Type de données : objet "metadata": { "location": "String", "resourceType": "String" } | | meta.location | URI du type de ressource associé sur l'instance associée ServiceNow . Type de données : chaîne | | meta.resourceType | Toujours \<\< ResourceType \>\>. Type de données : chaîne | | nom | Nom du type de ressource, par exemple Utilisateur ou Groupe. Type de données : chaîne | | Schéma | URI de schéma primaire/de base du type de ressource. Par exemple : `<< urn :ietf :params :scim :schemas :core :2.0 :User >>.` Type de données : chaîne | | Schémas | Schéma utilisé pour traiter la demande `/ResourceType` . Par exemple : `<< urn :ietf :params :scim :schemas :core :2.0 :ResourceType >>.` Type de données : chaîne | | schemaExtensions | Liste des extensions de schéma qui s'appliquent au type de ressource associé. Par exemple : `<< urn :ietf :params :scim :schemas :extension : servicenow :2.0 :User >>.` Type de données : tableau d'objets "schemaExtensions": { "required": Boolean, "schema": "String" } | | schemaExtensions.requis | Marqueur indiquant si l'extension de schéma est requise pour le type de ressource. Valeurs possibles : * vrai : une ressource de ce type doit inclure cette extension de schéma ainsi que tous les attributs déclarés comme requis dans cette extension de schéma. * false : une ressource de ce type peut omettre cette extension de schéma. {#scim-GET-ResourceTypes-ResourceName__ul_nng_2p3_3rb} Type de données : booléennes | | schemaExtensions.schema | URI d'un schéma étendu. Par exemple : `<< urn :ietf :params :scim :schemas :extension :servicenow : 2.0 :User >>.` Type de données : chaîne | | Schémas | Schéma utilisé pour traiter la réponse de liste à la demande. Par exemple : `<< urn :ietf :params :scim :api :messages :2.0 :ListResponse >>` Type de données : chaîne | [ ] {#scim-GET-ResourceTypes-ResourceName__id_avz_rp3_3rb} ### Demande cURL L'exemple suivant montre comment obtenir le type de ressource SCIM utilisateur à partir d'une ServiceNow instance. curl "https://instance-servicenow.com/api/now/scim/ResourceTypes/"User" \ --request GET \ --header "Accept:application/scim+json" \ Réponse { "schemas":[ "urn:ietf:params:scim:schemas:core:2.0:ResourceType" ], "id":"User", "name":"User", "description":"User Account", "endpoint":"/Users", "schema":"urn:ietf:params:scim:schemas:core:2.0:User", "schemaExtensions":[ { "schema":"urn:ietf:params:scim:schemas:extension:servicenow:2.0:User", "required":false }, { "schema":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User", "required":false } ], "meta":{ "resourceType":"ResourceType", "location":"https://instance-servicenow.com/api/now/scim/ResourceTypes/User" } } ## SCIM : GET /scim/Schémas {#ariaid-title16} Récupère des informations sur tous les schémas de ressources du système SCIM (Cross-domain Identity Management) pris en charge par une ServiceNow instance. Ces schémas définissent les attributs disponibles pour chaque type de ressource. Il s'agit d'un point de terminaison public dont l'accès ne nécessite aucun rôle. ### Format d'URL URL versionnée : /api/now/{api_version}/scim/Schemas URL par défaut : /api/now/scim/schemas ### Paramètres de demande pris en charge {#scim-GET-Schemas__entry__2}{#scim-GET-Schemas__version-RESTAPI} | Nom | Description | |-|-| | api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne | [Tableau 97. Paramètres de chemin d'accès] {#scim-GET-Schemas__entry__6} | Nom | Description | |-|-| | Aucun | | [Tableau 98. Paramètres de requête] {#scim-GET-Schemas__entry__10} | Nom | Description | |-|-| | Aucun | | [Tableau 99. Paramètres du corps de la demande (JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-GET-Schemas__entry__14}{#scim-GET-Schemas__Accept-SCIM-entry} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/scim+json. Valeur par défaut : application/json | [Tableau 100. En-têtes de demandes] {#scim-GET-Schemas__entry__18} | En-tête | Description | |-|-| | Aucun | | [Tableau 101. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-GET-Schemas__entry__22}{#scim-GET-Schemas__entry-200-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | [Tableau 102. Codes d'état] ### Paramètres de corps de réponse (JSON) {#scim-GET-Schemas__entry__26} | Nom | Description | |-|-| | Le RFC7643 standard renvoie des résultats | La méthode renvoie des résultats conformes à la norme RFC7643. Pour plus d'informations, reportez-vous à la [section Définition du schéma](https://datatracker.ietf.org/doc/html/rfc7643#section-7) dans la spécification RFC7643. | [ ] ### Demande cURL L'exemple suivant montre comment obtenir les schémas SCIM pris en charge par une ServiceNow instance. curl "https://instance-servicenow.com/api/now/scim/Schemas \ --request GET \ --header "Accept:application/scim+json" \ Réponse { "schemas":[ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ], "totalResults":8, "Resources":[ { "schemas":[ "urn:ietf:params:scim:schemas:core:2.0:Schema" ], "id":"urn:ietf:params:scim:schemas:core:2.0:User", "name":"User", "description":"User Account", "attributes":[ { "name":"active", "type":"boolean", "multiValued":false, "description":"A Boolean value indicating the User's administrative status.", "required":false, "caseExact":true, "mutability":"readWrite", "returned":"default", "uniqueness":"none" }, { "name":"addresses", "type":"complex", "subAttributes":[ { "name":"country", "type":"string", "multiValued":false, "description":"The country name component.", "required":false, "caseExact":false, "mutability":"readWrite", "returned":"default", "uniqueness":"none" }, { "name":"formatted", "type":"string", "multiValued":false, "description":"The full mailing address, formatted for display or use with a mailing label. This attribute MAY contain newlines.", "required":false, "caseExact":false, "mutability":"readWrite", "returned":"default", "uniqueness":"none" }, { "name":"locality", "type":"string", "multiValued":false, "description":"The city or locality component.", "required":false, "caseExact":false, "mutability":"readWrite", "returned":"default", "uniqueness":"none" }, { "name":"postalCode", "type":"string", "multiValued":false, "description":"The zipcode or postal code component.", "required":false, "caseExact":false, "mutability":"readWrite", "returned":"default", "uniqueness":"none" }, { "name":"primary", "type":"boolean", "multiValued":false, "description":"A Boolean value indicating the 'primary' or preferred attribute value for this attribute, e.g., the preferred address. The primary attribute value 'true' MUST appear no more than once.", "required":false, "caseExact":true, "mutability":"readWrite", "returned":"default", "uniqueness":"none" }, { "name":"region", "type":"string", "multiValued":false, "description":"The state or region component.", "required":false, "caseExact":false, "mutability":"readWrite", "returned":"default", "uniqueness":"none" }, { "name":"streetAddress", "type":"string", "multiValued":false, "description":"The full street address component, which may include house number, street name, PO BOX, and multi-line extended street address information. This attribute MAY contain newlines.", "required":false, "caseExact":false, "mutability":"readWrite", "returned":"default", "uniqueness":"none" }, { "name":"type", "type":"string", "multiValued":false, "description":"A label indicating the attribute's function; e.g., 'work' or 'home'.", "required":false, "canonicalValues":["other","work","home"], "caseExact":false, "mutability":"readWrite", "returned":"default", "uniqueness":"none" } ], "multiValued":true, "description":"Physical mailing addresses for this User.", "required":false, "caseExact":true, "mutability":"readWrite", "returned":"default", "uniqueness":"none" }, . . . { "schemas":[ "urn:ietf:params:scim:schemas:core:2.0:Schema" ], "id":"urn:ietf:params:scim:schemas:custom:servicenow:2.0:Department", "name":"Department", "description":"Department", "attributes":[ { "name":"name", "type":"string", "multiValued":false, "description":"The name of the department.", "required":false, "caseExact":false, "mutability":"readOnly", "returned":"default", "uniqueness":"none" } ], "meta":{ "resourceType":"Schema", "location":"https://instance-servicenow.com/api/now/scim/Schemas/urn:ietf:params:scim:schemas:custom:servicenow:2.0:Department" } }, { "schemas":[ "urn:ietf:params:scim:schemas:core:2.0:Schema" ], "id":"urn:ietf:params:scim:schemas:custom:servicenow:2.0:CostCenter", "name":"CostCenter", "description":"CostCenter", "attributes":[ { "name":"name", "type":"string", "multiValued":false, "description":"The name of the cost center.", "required":false, "caseExact":false, "mutability":"readOnly", "returned":"default", "uniqueness":"none" } ], "meta": { "resourceType":"Schema", "location":"https://instance.servicenow.com/api/now/scim/Schemas/urn:ietf:params:scim:schemas:custom:servicenow:2.0:CostCenter" } }, { "schemas":[ "urn:ietf:params:scim:schemas:core:2.0:Schema" ], "id":"urn:ietf:params:scim:schemas:custom:servicenow:2.0:Location", "name":"Location", "description":"Location", "attributes":[ { "name":"name", "type":"string", "multiValued":false, "description":"The location name.", "required":false, "caseExact":false, "mutability":"readOnly", "returned":"default", "uniqueness":"none" } ], "meta":{ "resourceType":"Schema", "location":"https://instance.servicenow.com/api/now/scim/Schemas/urn:ietf:params:scim:schemas:custom:servicenow:2.0:Location" } } ], "startIndex":1, "itemsPerPage":8 } ## SCIM - GET /scim/Schemas/{SchemaName} {#ariaid-title17} Récupère des informations sur le système spécifié pour les schémas de ressources SCIM (Cross-domain Identity Management) pris en charge par une ServiceNow instance. Ces schémas définissent les attributs disponibles pour chaque type de ressource. Il s'agit d'un point de terminaison public dont l'accès ne nécessite aucun rôle. ### Format d'URL URL versionnée : /api/now/{api_version}/scim/Schemas/{SchemaName} URL par défaut : /api/now/scim/schemas/{SchemaName} ### Paramètres de demande pris en charge {#scim-GET-Schemas-SchemaName__entry__2}{#scim-GET-Schemas-SchemaName__version-RESTAPI} | Nom | Description | |-|-| | api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne | | Nom du schéma | URI du schéma de ressources à renvoyer. Valeurs valides : * urn :ietf :params :scim :schemas :core :2.0 :User * urn :ietf :params :scim :schemas :extension : enterprise :2.0 :User * urn :ietf :params :scim :schemas :extension : servicenow :2.0 :User * urn :ietf :params :scim :schemas :core :2.0 :Group * urn :ietf :params :scim :schemas :custom : servicenow :2.0 :Company * urn :ietf :params :scim :schemas :custom : servicenow :2.0 :Department * urn :ietf :params :scim :schemas :custom : servicenow :2.0 :CostCenter * urn :ietf :params :scim :schemas :custom : servicenow :2.0 :Location Type de données : chaîne | [Tableau 103. Paramètres de chemin d'accès] {#scim-GET-Schemas-SchemaName__entry__8} | Nom | Description | |-|-| | Aucun | | [Tableau 104. Paramètres de requête] {#scim-GET-Schemas-SchemaName__entry__12} | Nom | Description | |-|-| | Aucun | | [Tableau 105. Paramètres du corps de la demande (JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-GET-Schemas-SchemaName__entry__16}{#scim-GET-Schemas-SchemaName__Accept-SCIM-entry} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/scim+json. Valeur par défaut : application/json | [Tableau 106. En-têtes de demandes] {#scim-GET-Schemas-SchemaName__entry__20} | En-tête | Description | |-|-| | Aucun | | [Tableau 107. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-GET-Schemas-SchemaName__entry__24}{#scim-GET-Schemas-SchemaName__entry-200-status-code}{#scim-GET-Schemas-SchemaName__entry-404-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 404 | Introuvable. L'élément demandé est introuvable. | [Tableau 108. Codes d'état] ### Paramètres de corps de réponse (JSON) {#scim-GET-Schemas-SchemaName__entry__30} | Nom | Description | |-|-| | Le RFC7643 standard renvoie des résultats | La méthode renvoie des résultats conformes à la norme RFC7643. Pour plus d'informations, reportez-vous à la [section Définition du schéma](https://datatracker.ietf.org/doc/html/rfc7643#section-7) dans la spécification RFC7643. | [ ] ### Demande cURL L'exemple suivant montre comment obtenir le schéma SCIM du groupe principal à partir d'une ServiceNow instance. curl "https://instance-servicenow.com/api/now/scim/Schemas/"urn:ietf:params:scim:schemas:core:2.0:Group" \ --request GET \ --header "Accept:application/scim+json" \ Réponse { "schemas":[ "urn:ietf:params:scim:schemas:core:2.0:Schema" ], "id":"urn:ietf:params:scim:schemas:core:2.0:Group", "name":"Group", "description":"Group", "attributes":[ { "name":"displayName", "type":"string", "multiValued":false, "description":"A human-readable name for the Group.", "required":true, "caseExact":false, "mutability":"readWrite", "returned":"default", "uniqueness":"none" }, { "name":"members", "type":"complex", "subAttributes":[ { "name":"display", "type":"string", "multiValued":false, "description":"A human readable name, primarily used for display purposes.", "required":false, "caseExact":false, "mutability":"immutable", "returned":"default", "uniqueness":"none" }, { "name":"value", "type":"string", "multiValued":false, "description":"The identifier of a group member.", "required":true, "caseExact":false, "mutability":"immutable", "returned":"default", "uniqueness":"none" }, { "name":"$ref", "type":"reference", "multiValued":false, "description":"The URI of the member resource.", "required":false, "caseExact":true, "mutability":"immutable", "returned":"default", "uniqueness":"none", "referenceTypes":["Group","User"] } ], "multiValued":true, "description":"A list of members of the Group.", "required":false, "caseExact":true, "mutability":"readWrite", "returned":"default", "uniqueness":"none" } ], "meta":{ "resourceType":"Schema", "location":"https://instance-servicenow.com/api/now/scim/Schemas/urn:ietf:params:scim:schemas:core:2.0:Group" } } ## SCIM : GET /scim/ServiceProviderConfig {#ariaid-title18} Renvoie les métadonnées de configuration à utiliser pour obtenir des informations sur les options de service, les configurations, les schémas et les types de ressources pour les points de terminaison SCIM (System for Cross-domain Identity Management) disponibles au sein d'une ServiceNow instance. Il s'agit d'un point de terminaison public dont l'accès ne nécessite aucun rôle. ### Format d'URL URL versionnée : /api/now/{api_version}/scim/ServiceProviderConfig URL par défaut : /api/now/scim/ServiceProviderConfig ### Paramètres de demande pris en charge {#scim-GET-ServiceProviderConfig__entry__2}{#scim-GET-ServiceProviderConfig__version-RESTAPI} | Nom | Description | |-|-| | api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne | [Tableau 109. Paramètres de chemin d'accès] {#scim-GET-ServiceProviderConfig__entry__6} | Nom | Description | |-|-| | Aucun | | [Tableau 110. Paramètres de requête] {#scim-GET-ServiceProviderConfig__entry__10} | Nom | Description | |-|-| | Aucun | | [Tableau 111. Paramètres du corps de la demande (JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-GET-ServiceProviderConfig__entry__14}{#scim-GET-ServiceProviderConfig__Accept-SCIM-entry} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/scim+json. Valeur par défaut : application/json | [Tableau 112. En-têtes de demandes] {#scim-GET-ServiceProviderConfig__entry__18} | En-tête | Description | |-|-| | Aucun | | [Tableau 113. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-GET-ServiceProviderConfig__entry__22}{#scim-GET-ServiceProviderConfig__entry-200-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | [Tableau 114. Codes d'état] ### Paramètres de corps de réponse (JSON) {#scim-GET-ServiceProviderConfig__entry__26} | Nom | Description | |-|-| | Le RFC7643 standard renvoie des résultats | La méthode renvoie des résultats conformes à la norme RFC7643. Pour plus d'informations, reportez-vous à la section [Schéma de configuration du fournisseur de service](https://datatracker.ietf.org/doc/html/rfc7643#section-5) dans la spécification RFC7643. | [ ] ### Demande cURL L'exemple suivant montre comment obtenir les métadonnées de configuration SCIM pour une ServiceNow instance. curl "https://instance-servicenow.com/api/now/scim/ServiceProviderConfig \ --request GET \ --header "Accept:application/scim+json" \ Réponse { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig" ], "patch": { "supported": true }, "bulk": { "supported": false, "maxOperations": 0, "maxPayloadSize": 1000000 }, "filter": { "supported": true, "maxResults": 500 }, "changePassword": { "supported": false }, "sort": { "supported": false }, "etag": { "supported": false }, "authenticationSchemes": [ { "name": "OAuth 2.0 Bearer Token", "description": "The OAuth 2.0 Bearer Token Authentication scheme. OAuth enables clients to access protected resources by obtaining an access token, which is defined in RFC 6750 as \"a string representing an access authorization issued to the client\", rather than using the resource owner's credentials directly.", "specUri": "http://tools.ietf.org/html/rfc6750", "type": "oauthbearertoken", "primary": true } ] } ## SCIM - GET /scim/Companies {#ariaid-title19} Renvoie un ou plusieurs enregistrements de société de la table \[core_company\] au sein d'une ServiceNow instance utilisant le protocole SCIM (System for Cross-domain Identity Management). Remarque : Une requête qui ne renvoie aucune correspondance renvoie un message de réussite (code d'état HTTP 200) avec totalResults la valeur 0. ### Format d'URL URL versionnée : /api/now/{api_version}/scim/Companies URL par défaut : /api/now/scim/Companies ### Paramètres de demande pris en charge {#scim-GET-Companies__entry__2}{#scim-GET-Companies__version-RESTAPI} | Nom | Description | |-|-| | api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne | [Tableau 115. Paramètres de chemin d'accès] {#scim-GET-Companies__entry__6}{#scim-GET-Companies__attributes-SCIM-entry}{#scim-GET-Companies__count-SCIM-entry}{#scim-GET-Companies__excludedAttributes-SCIM-entry}{#scim-GET-Companies__group_sortBy-SCIM-entry}{#scim-GET-Companies__sortOrder-SCIM-entry}{#scim-GET-Companies__group_startIndex-SCIM-entry} | Nom | Description | |-|-| | attributs | Liste des champs séparés par des virgules à envoyer dans la réponse. Aucun autre champ n'est renvoyé. Ne peut pas être utilisé avec le excludedAttributes paramètre. Type de données : chaîne Par défaut : renvoie tous les champs sauf s'il excludedAttributes est spécifié. | | compter | Nombre d'enregistrements à renvoyer. Une valeur négative est interprétée comme zéro. Type de données : nombre Maximum : 500 : une valeur supérieure à cette valeur entraîne une erreur de demande incorrecte. Par défaut : 10 | | Attributs exclus | Liste de champs séparés par des virgules à exclure des enregistrements renvoyés dans la réponse. Tous les autres champs sont renvoyés. Ne peut pas être utilisé avec le attributes paramètre. Type de données : chaîne Par défaut : n'excluez aucun champ. | | filtre | Expression de filtre à appliquer aux résultats renvoyés. Les filtres de champ sont exprimés sous la forme ` <"valeur>`. Consultez [RFC7644](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2) pour obtenir la liste des opérateurs valides. Remarque : `L'opérateur NOT` n'est pas pris en charge par cette méthode. Par exemple, pour filtrer toutes les sociétés dont le nom commence par \<\< Acme \>\>, saisissez `displayName SW << Acme >>.` Pour spécifier plusieurs filtres de champ, concaténez les filtres à l'aide de l'opérande `ET` . Par exemple, pour filtrer toutes les sociétés dont le nom commence par \<\< Acme \>\> et dont la dernière modification a été effectuée avant le 3 octobre 2021, saisissez `displayName SW << Acme >> ET meta.lastModified lt << 2021-10-03T00:00:00Z >>.` Utilisez la remontée pas à pas pour spécifier les attributs imbriqués. Type de données : chaîne Par défaut : aucun filtrage | | trier par | Doit être spécifié avec le sortOrder paramètre. Champ utilisé pour trier les résultats renvoyés. Le tri n'est pas sensible à la casse. Vous ne pouvez utiliser que les paramètres disponibles pour le filtrage du sortBy paramètre, sauf si cela externalId n'est pas autorisé. Pour les valeurs nulles : * Trié par ordre croissant : les valeurs nulles sont triées tout en haut. * trié par ordre décroissant : les valeurs nulles sont triées en bas. {#scim-GET-Companies__ul_xsb_zmm_hrb} Type de données : chaîne Par défaut : aucun tri | | sortOrder | Doit être spécifié avec le sortBy paramètre. Ordre dans lequel le sortBy paramètre est appliqué aux résultats renvoyés. Valeurs valides : * ascendant * descendant {#scim-GET-Companies__ul_mmn_zrc_grb} Type de données : chaîne Par défaut : croissant | | startIndex | Index de base unique dans la table à partir de laquelle commencer à récupérer les enregistrements. Par exemple, si vous définissez ce paramètre sur 100 et le count paramètre sur 20, le point de terminaison renvoie les enregistrements 100 à 119. Remarque : Toute valeur qui est définie sur moins de un est interprétée comme un. Type de données : chaîne Valeur par défaut : 1 | [Tableau 116. Paramètres de requête] {#scim-GET-Companies__entry__22} | Nom | Description | |-|-| | Aucun | | [Tableau 117. Paramètres du corps de la demande (JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-GET-Companies__entry__26}{#scim-GET-Companies__Accept-SCIM-entry} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/scim+json. Valeur par défaut : application/json | [Tableau 118. En-têtes de demandes] {#scim-GET-Companies__entry__30} | En-tête | Description | |-|-| | Aucun | | [Tableau 119. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-GET-Companies__entry__34}{#scim-GET-Companies__entry-200-status-code}{#scim-GET-Companies__status_400-SCIM-entry}{#scim-GET-Companies__entry-401-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. * Assurez-vous que les paramètres de requête et excludedAttributes n'ont attributes pas été transmis dans la demande. * Assurez-vous que le paramètre n'est count pas supérieur à 500. * Assurez-vous que tous les filter paramètres sont valides. {#scim-GET-Companies__ul_vn1_gvz_nrb} | | 401 | Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises. | [Tableau 120. Codes d'état] ### Paramètres de corps de réponse (JSON) {#scim-GET-Companies__id_uwg_55q_3rb__entry__2}{#scim-GET-Companies__itemsPerPage-SCIM-entry}{#scim-GET-Companies__totalResults-SCIM-entry} | Nom | Description | |-|-| | itemsPerPage | Nombre d'enregistrements renvoyés dans les résultats renvoyés. Type de données : nombre | | Ressources | Liste des enregistrements de centre de coûts renvoyés. Type de données : objet "Resources": { "id": "String", "meta": {Object}, "name": "String", "schemas": "String" } | | Resources.id | Sys_id de l'enregistrement de société. Type de données : chaîne | | Ressources.meta | Informations relatives à l'enregistrement de la société. Type de données : objet "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" } | | Ressources.meta.créé | Date et heure de création de l'enregistrement de société associé. Type de données : chaîne | | Ressources.meta.lastModified | Date et heure de la dernière modification de l'enregistrement de société associé. Type de données : chaîne | | Ressources.meta.location | URI de l'enregistrement de société associé. Type de données : chaîne | | Resources.meta.resourceType | type de ressource SCIM ; toujours la Compagnie. Type de données : chaîne | | Resources.name | Nom de la société Type de données : chaîne | | Resources.schemas | Schéma utilisé lors du traitement de la demande. Type de données : chaîne | | Schémas | Schéma utilisé pour traiter la réponse de liste à la demande. Par exemple : `<< urn :ietf :params :scim :api :messages :2.0 :ListResponse >>` Type de données : chaîne | | startIndex | Index de base unique dans la table Société \[core_company\] dans laquelle les enregistrements ont été renvoyés. Type de données : chaîne | | totalResults | Nombre total d'enregistrements qui correspondent à la demande. Type de données : nombre | [ ] {#scim-GET-Companies__id_uwg_55q_3rb} ### Demande cURL Cet exemple montre comment récupérer les deux premiers enregistrements de société. curl "https://instance-servicenow.com/api/now/scim/Companies?count=2" \ --request GET \ --header "Accept:application/scim+json" \ Réponse : { "schemas":[ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ], "totalResults":182, "Resources":[ { "schemas":[ "urn:ietf:params:scim:schemas:custom:servicenow:2.0:Company" ], "id":"0c43af40c6112275011a4bd4c0143fbf", "meta":{ "resourceType":"Company", "created":"2005-05-24T01:14:19Z", "lastModified":"2013-05-06T23:44:48Z", "location":"https://instance-servicenow.com/api/now/scim/Companies/0c43af40c6112275011a4bd4c0143fbf" }, "name":"ABC Company" }, { "schemas":[ "urn:ietf:params:scim:schemas:custom:servicenow:2.0:Company" ], "id":"0c43b088c6112275011a4bd46a4e6cc4", "meta":{ "resourceType":"Company", "created":"2005-05-24T01:14:19Z", "lastModified":"2013-06-05T17:53:26Z", "location":"https://instance-servicenow.com/api/now/scim/Companies/0c43b088c6112275011a4bd46a4e6cc4" }, "name":"Acme Co" } ], "startIndex":1, "itemsPerPage":2 } ## SCIM - GET /scim/Companies/{company_id} {#ariaid-title20} Renvoie l'enregistrement de société spécifié à partir de la table Société \[core_company\] au sein d'une ServiceNow instance utilisant le protocole SCIM (System for Cross-domain Identity Management).
### Format d'URL URL versionnée : /api/now/{api_version}/scim/Companies/{company_id} URL par défaut : /api/now/scim/groups/{company_id} ### Paramètres de demande pris en charge {#scim-GET-Companies-company_id__entry__2}{#scim-GET-Companies-company_id__version-RESTAPI} | Nom | Description | |-|-| | api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne | | company_id | Sys_id de l'enregistrement de société à renvoyer. Type de données : chaîne | [Tableau 121. Paramètres de chemin d'accès] {#scim-GET-Companies-company_id__entry__8}{#scim-GET-Companies-company_id__attributes-SCIM-entry}{#scim-GET-Companies-company_id__excludedAttributes-SCIM-entry} | Nom | Description | |-|-| | attributs | Liste des champs séparés par des virgules à envoyer dans la réponse. Aucun autre champ n'est renvoyé. Ne peut pas être utilisé avec le excludedAttributes paramètre. Type de données : chaîne Par défaut : renvoie tous les champs sauf s'il excludedAttributes est spécifié. | | Attributs exclus | Liste de champs séparés par des virgules à exclure des enregistrements renvoyés dans la réponse. Tous les autres champs sont renvoyés. Ne peut pas être utilisé avec le attributes paramètre. Type de données : chaîne Par défaut : n'excluez aucun champ. | [Tableau 122. Paramètres de requête] {#scim-GET-Companies-company_id__entry__14} | Nom | Description | |-|-| | Aucun | | [Tableau 123. Paramètres du corps de la demande (JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-GET-Companies-company_id__entry__18}{#scim-GET-Companies-company_id__Accept-SCIM-entry} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/scim+json. Valeur par défaut : application/json | [Tableau 124. En-têtes de demandes] {#scim-GET-Companies-company_id__entry__22} | En-tête | Description | |-|-| | Aucun | | [Tableau 125. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-GET-Companies-company_id__entry__26}{#scim-GET-Companies-company_id__entry-200-status-code}{#scim-GET-Companies-company_id__status_400-SCIM-entry}{#scim-GET-Companies-company_id__entry-401-status-code}{#scim-GET-Companies-company_id__entry-404-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. * Assurez-vous que les paramètres de requête et excludedAttributes n'ont attributes pas été transmis dans la demande. * Assurez-vous que le paramètre n'est count pas supérieur à 500. * Assurez-vous que tous les filter paramètres sont valides. {#scim-GET-Companies-company_id__ul_vn1_gvz_nrb} | | 401 | Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises. | | 404 | Introuvable. L'élément demandé est introuvable. | [Tableau 126. Codes d'état] ### Paramètres de corps de réponse (JSON) {#scim-GET-Companies-company_id__id_mvt_mbq_3rb__entry__2}{#scim-GET-Companies-company_id__id-company-SCIM-entry}{#scim-GET-Companies-company_id__meta-company-SCIM-entry}{#scim-GET-Companies-company_id__meta_created-company-SCIM-entry}{#scim-GET-Companies-company_id__meta_lastModified-company-SCIM-entry}{#scim-GET-Companies-company_id__meta_location-company-SCIM-entry}{#scim-GET-Companies-company_id__meta_resourceType-company-SCIM-entry}{#scim-GET-Companies-company_id__name-company-SCIM-entry}{#scim-GET-Companies-company_id__schemas-company-SCIM-entry} | Nom | Description | |-|-| | id | Sys_id de l'enregistrement de société. Type de données : chaîne | | métadonnées | Informations relatives à l'enregistrement de la société. Type de données : objet "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" } | | meta.created | Date et heure de création de l'enregistrement de société associé. Type de données : chaîne | | meta.lastModified | Date et heure de la dernière modification de l'enregistrement de société associé. Type de données : chaîne | | meta.location | URI de l'enregistrement de société associé. Type de données : chaîne | | meta.resourceType | type de ressource SCIM ; toujours la Compagnie. Type de données : chaîne | | nom | Nom de la société Type de données : chaîne | | Schémas | Schéma utilisé lors du traitement de la demande. Type de données : chaîne | [ ] {#scim-GET-Companies-company_id__id_mvt_mbq_3rb} ### Demande cURL Cet exemple montre comment récupérer un enregistrement de société spécifique. curl "https://instance-servicenow.com/api/now/scim/Companies/0c43af40c6112275011a4bd4c0143fbf" \ --request GET \ --header "Accept:application/scim+json" \ Réponse { "schemas":[ "urn:ietf:params:scim:schemas:custom:servicenow:2.0:Company" ], "id":"0c43af40c6112275011a4bd4c0143fbf", "meta":{ "resourceType":"Company", "created":"2005-05-24T01:14:19Z", "lastModified":"2013-05-06T23:44:48Z", "location":"https://instance-servicenow.com/api/now/scim/Companies/0c43af40c6112275011a4bd4c0143fbf" }, "name":"ABC Company" } ## SCIM - GET /scim/CostCenters {#ariaid-title21} Renvoie un ou plusieurs enregistrements de centre de coûts de la table Centre de coûts \[cmn_cost_center\] au sein d'une ServiceNow instance utilisant le protocole SCIM (System for Cross-domain Identity Management). Remarque : Une requête qui ne renvoie aucune correspondance renvoie un message de réussite (code d'état HTTP 200) avec totalResults la valeur 0. ### Format d'URL URL versionnée : /api/now/{api_version}/scim/CostCenters URL par défaut : /api/now/scim/CostCenters ### Paramètres de demande pris en charge {#scim-GET-CostCenters__entry__2}{#scim-GET-CostCenters__version-RESTAPI} | Nom | Description | |-|-| | api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne | [Tableau 127. Paramètres de chemin d'accès] {#scim-GET-CostCenters__entry__6}{#scim-GET-CostCenters__attributes-SCIM-entry}{#scim-GET-CostCenters__count-SCIM-entry}{#scim-GET-CostCenters__excludedAttributes-SCIM-entry}{#scim-GET-CostCenters__group_sortBy-SCIM-entry}{#scim-GET-CostCenters__sortOrder-SCIM-entry}{#scim-GET-CostCenters__group_startIndex-SCIM-entry} | Nom | Description | |-|-| | attributs | Liste des champs séparés par des virgules à envoyer dans la réponse. Aucun autre champ n'est renvoyé. Ne peut pas être utilisé avec le excludedAttributes paramètre. Type de données : chaîne Par défaut : renvoie tous les champs sauf s'il excludedAttributes est spécifié. | | compter | Nombre d'enregistrements à renvoyer. Une valeur négative est interprétée comme zéro. Type de données : nombre Maximum : 500 : une valeur supérieure à cette valeur entraîne une erreur de demande incorrecte. Par défaut : 10 | | Attributs exclus | Liste de champs séparés par des virgules à exclure des enregistrements renvoyés dans la réponse. Tous les autres champs sont renvoyés. Ne peut pas être utilisé avec le attributes paramètre. Type de données : chaîne Par défaut : n'excluez aucun champ. | | filtre | Expression de filtre à appliquer aux résultats renvoyés. Les filtres de champ sont exprimés sous la forme ` <"valeur>`. Consultez [RFC7644](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2) pour obtenir la liste des opérateurs valides. Remarque : `L'opérateur NOT` n'est pas pris en charge par cette méthode. Par exemple, pour filtrer tous les centres de coûts dont le nom commence par \<\< RH \>\>, saisissez `displayName SW << RH >>.` Pour spécifier plusieurs filtres de champ, concaténez les filtres à l'aide de l'opérande `ET` . Par exemple, pour filtrer tous les centres de coûts dont le nom commence par \<\< RH \>\> et dont la dernière modification a été effectuée avant le 3 octobre 2021, saisissez `displayName SW << HR >> ET meta.lastModified lt << 2021-10-03T00:00:00Z >>.` Utilisez la remontée pas à pas pour spécifier les attributs imbriqués. Type de données : chaîne Par défaut : aucun filtrage | | trier par | Doit être spécifié avec le sortOrder paramètre. Champ utilisé pour trier les résultats renvoyés. Le tri n'est pas sensible à la casse. Vous ne pouvez utiliser que les paramètres disponibles pour le filtrage du sortBy paramètre, sauf si cela externalId n'est pas autorisé. Pour les valeurs nulles : * Trié par ordre croissant : les valeurs nulles sont triées tout en haut. * trié par ordre décroissant : les valeurs nulles sont triées en bas. {#scim-GET-CostCenters__ul_xsb_zmm_hrb} Type de données : chaîne Par défaut : aucun tri | | sortOrder | Doit être spécifié avec le sortBy paramètre. Ordre dans lequel le sortBy paramètre est appliqué aux résultats renvoyés. Valeurs valides : * ascendant * descendant {#scim-GET-CostCenters__ul_mmn_zrc_grb} Type de données : chaîne Par défaut : croissant | | startIndex | Index de base unique dans la table à partir de laquelle commencer à récupérer les enregistrements. Par exemple, si vous définissez ce paramètre sur 100 et le count paramètre sur 20, le point de terminaison renvoie les enregistrements 100 à 119. Remarque : Toute valeur qui est définie sur moins de un est interprétée comme un. Type de données : chaîne Valeur par défaut : 1 | [Tableau 128. Paramètres de requête] {#scim-GET-CostCenters__entry__22} | Nom | Description | |-|-| | Aucun | | [Tableau 129. Paramètres du corps de la demande (SON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-GET-CostCenters__entry__26}{#scim-GET-CostCenters__Accept-SCIM-entry} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/scim+json. Valeur par défaut : application/json | [Tableau 130. En-têtes de demandes] {#scim-GET-CostCenters__entry__30} | En-tête | Description | |-|-| | Aucun | | [Tableau 131. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-GET-CostCenters__entry__34}{#scim-GET-CostCenters__entry-200-status-code}{#scim-GET-CostCenters__status_400-SCIM-entry}{#scim-GET-CostCenters__entry-401-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. * Assurez-vous que les paramètres de requête et excludedAttributes n'ont attributes pas été transmis dans la demande. * Assurez-vous que le paramètre n'est count pas supérieur à 500. * Assurez-vous que tous les filter paramètres sont valides. {#scim-GET-CostCenters__ul_vn1_gvz_nrb} | | 401 | Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises. | [Tableau 132. Codes d'état] ### Paramètres de corps de réponse (JSON) {#scim-GET-CostCenters__id_tld_hxq_3rb__entry__2}{#scim-GET-CostCenters__itemsPerPage-SCIM-entry}{#scim-GET-CostCenters__totalResults-SCIM-entry} | Nom | Description | |-|-| | itemsPerPage | Nombre d'enregistrements renvoyés dans les résultats renvoyés. Type de données : nombre | | Ressources | Liste des enregistrements de centre de coûts renvoyés. Type de données : objet "Resources": { "id": "String", "meta": {Object}, "name": "String", "schemas": "String" } | | Resources.id | Sys_id de l'enregistrement de centre de coûts. Type de données : chaîne | | Ressources.meta | Informations relatives à l'enregistrement de centre de coûts. Type de données : objet "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" } | | Ressources.meta.créé | Date et heure de création de l'enregistrement du centre de coûts associé. Type de données : chaîne | | Ressources.meta.lastModified | Date et heure de la dernière modification de l'enregistrement du centre de coûts associé. Type de données : chaîne | | Ressources.meta.location | URI de l'enregistrement de centre de coûts associé. Type de données : chaîne | | Resources.meta.resourceType | type de ressource SCIM ; toujours CostCenter. Type de données : chaîne | | Resources.name | Nom du centre de coûts. Type de données : chaîne | | Resources.schemas | Schéma utilisé lors du traitement de la demande. Type de données : chaîne | | Schémas | Schéma utilisé pour traiter la réponse de liste à la demande. Par exemple : `<< urn :ietf :params :scim :api :messages :2.0 :ListResponse >>` Type de données : chaîne | | startIndex | Index de base unique dans la table Centre de coûts \[cmn_cost_center\] dans laquelle les enregistrements ont été renvoyés. Type de données : chaîne | | totalResults | Nombre total d'enregistrements qui correspondent à la demande. Type de données : nombre | [ ] {#scim-GET-CostCenters__id_tld_hxq_3rb} ### Demande cURL Cet exemple montre comment récupérer les deux premiers enregistrements de centre de coûts. curl "https://instance-servicenow.com/api/now/scim/CostCenters?count=2" \ --request GET \ --header "Accept:application/scim+json" \ Réponse { "schemas":[ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ], "totalResults":8, "Resources":[ { "schemas":[ "urn:ietf:params:scim:schemas:custom:servicenow:2.0:CostCenter" ], "id":"7fb1cc99c0a80a6d30c04574d14c0acf", "meta":{ "resourceType":"CostCenter", "created":"2012-01-19T21:02:39Z", "lastModified":"2012-02-25T23:06:36Z", "location":"https://instance-servicenow.com/api/now/scim/CostCenters/7fb1cc99c0a80a6d30c04574d14c0acf" }, "name":"Sales" }, { "schemas":[ "urn:ietf:params:scim:schemas:custom:servicenow:2.0:CostCenter" ], "id":"91e8bbf43710200044e0bfc8bcbe5daa", "meta":{ "resourceType":"CostCenter", "created":"2012-02-18T04:40:24Z", "lastModified":"2012-02-25T23:05:58Z", "location":"https://instance-servicenow.com/api/now/scim/CostCenters/91e8bbf43710200044e0bfc8bcbe5daa" }, "name":"Customer Support" } ], "startIndex":1, "itemsPerPage":2 } ## SCIM - GET /scim/CostCenters/{cost_center_id} {#ariaid-title22} Renvoie l'enregistrement du centre de coûts spécifié à partir de la table Centre de coûts \[cmn_cost_center\] au sein d'une ServiceNow instance utilisant le protocole SCIM (System for Inter-domain Identity Management). Remarque : Une requête qui ne renvoie aucune correspondance renvoie un message de réussite (code d'état HTTP 200) avec totalResults la valeur 0. ### Format d'URL URL versionnée : /api/now/{api_version}/scim/CostCenters/{cost_center_id} URL par défaut : /api/now/scim/CoostCenters/{cost_center_id} ### Paramètres de demande pris en charge {#scim-GET-CostCenters-cost_center_id__entry__2}{#scim-GET-CostCenters-cost_center_id__version-RESTAPI} | Nom | Description | |-|-| | api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne | | cost_center_id | Sys_id de l'enregistrement de centre de coûts à renvoyer. Type de données : chaîne | [Tableau 133. Paramètres de chemin d'accès] {#scim-GET-CostCenters-cost_center_id__entry__8}{#scim-GET-CostCenters-cost_center_id__attributes-SCIM-entry}{#scim-GET-CostCenters-cost_center_id__excludedAttributes-SCIM-entry} | Nom | Description | |-|-| | attributs | Liste des champs séparés par des virgules à envoyer dans la réponse. Aucun autre champ n'est renvoyé. Ne peut pas être utilisé avec le excludedAttributes paramètre. Type de données : chaîne Par défaut : renvoie tous les champs sauf s'il excludedAttributes est spécifié. | | Attributs exclus | Liste de champs séparés par des virgules à exclure des enregistrements renvoyés dans la réponse. Tous les autres champs sont renvoyés. Ne peut pas être utilisé avec le attributes paramètre. Type de données : chaîne Par défaut : n'excluez aucun champ. | [Tableau 134. Paramètres de requête] {#scim-GET-CostCenters-cost_center_id__entry__14} | Nom | Description | |-|-| | Aucun | | [Tableau 135. Paramètres du corps de la demande (JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-GET-CostCenters-cost_center_id__entry__18}{#scim-GET-CostCenters-cost_center_id__Accept-SCIM-entry} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/scim+json. Valeur par défaut : application/json | [Tableau 136. En-têtes de demandes] {#scim-GET-CostCenters-cost_center_id__entry__22} | En-tête | Description | |-|-| | Aucun | | [Tableau 137. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-GET-CostCenters-cost_center_id__entry__26}{#scim-GET-CostCenters-cost_center_id__entry-200-status-code}{#scim-GET-CostCenters-cost_center_id__status_400-SCIM-entry}{#scim-GET-CostCenters-cost_center_id__entry-401-status-code}{#scim-GET-CostCenters-cost_center_id__entry-404-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. * Assurez-vous que les paramètres de requête et excludedAttributes n'ont attributes pas été transmis dans la demande. * Assurez-vous que le paramètre n'est count pas supérieur à 500. * Assurez-vous que tous les filter paramètres sont valides. {#scim-GET-CostCenters-cost_center_id__ul_vn1_gvz_nrb} | | 401 | Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises. | | 404 | Introuvable. L'élément demandé est introuvable. | [Tableau 138. Codes d'état] ### Paramètres de corps de réponse (JSON) {#scim-GET-CostCenters-cost_center_id__id_tld_hxq_3rb__entry__2}{#scim-GET-CostCenters-cost_center_id__id-costcenter-SCIM-entry}{#scim-GET-CostCenters-cost_center_id__meta-costcenter-SCIM-entry}{#scim-GET-CostCenters-cost_center_id__meta_created-costcenter-SCIM-entry}{#scim-GET-CostCenters-cost_center_id__meta_lastModified-costcenter-SCIM-entry}{#scim-GET-CostCenters-cost_center_id__meta_location-costcenter-SCIM-entry}{#scim-GET-CostCenters-cost_center_id__meta_resourceType-costcenter-SCIM-entry}{#scim-GET-CostCenters-cost_center_id__name-costcenter-SCIM-entry}{#scim-GET-CostCenters-cost_center_id__schemas-costcenter-SCIM-entry} | Nom | Description | |-|-| | id | Sys_id de l'enregistrement de centre de coûts. Type de données : chaîne | | métadonnées | Informations relatives à l'enregistrement de centre de coûts. Type de données : objet "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" } | | meta.created | Date et heure de création de l'enregistrement du centre de coûts associé. Type de données : chaîne | | meta.lastModified | Date et heure de la dernière modification de l'enregistrement du centre de coûts associé. Type de données : chaîne | | meta.location | URI de l'enregistrement de centre de coûts associé. Type de données : chaîne | | meta.resourceType | type de ressource SCIM ; toujours CostCenter. Type de données : chaîne | | nom | Nom du centre de coûts. Type de données : chaîne | | Schémas | Schéma utilisé lors du traitement de la demande. Type de données : chaîne | [ ] {#scim-GET-CostCenters-cost_center_id__id_tld_hxq_3rb} ### Demande cURL Cet exemple montre comment récupérer un enregistrement de centre de coûts spécifique. curl "https://instance-servicenow.com/api/now/scim/CostCenters/7fb1cc99c0a80a6d30c04574d14c0acf" \ --request GET \ --header "Accept:application/scim+json" \ Réponse { "schemas":[ "urn:ietf:params:scim:schemas:custom:servicenow:2.0:CostCenter" ], "id":"7fb1cc99c0a80a6d30c04574d14c0acf", "meta":{ "resourceType":"CostCenter", "created":"2012-01-19T21:02:39Z", "lastModified":"2012-02-25T23:06:36Z", "location":"https://instance-servicenow.com/api/now/scim/CostCenters/7fb1cc99c0a80a6d30c04574d14c0acf" }, "name":"Sales" } ## SCIM : GET /scim/Departments {#ariaid-title23} Renvoie un ou plusieurs enregistrements de département de la table Département \[cmn_department\] au sein d'une ServiceNow instance utilisant le protocole SCIM (System for Cross-domain Identity Management). Remarque : Une requête qui ne renvoie aucune correspondance renvoie un message de réussite (code d'état HTTP 200) avec totalResults la valeur 0. ### Format d'URL URL versionnée : /api/now/{api_version}/scim/Departments URL par défaut : /api/now/scim/Departments ### Paramètres de demande pris en charge {#scim-GET-Departments__entry__2}{#scim-GET-Departments__version-RESTAPI} | Nom | Description | |-|-| | api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne | [Tableau 139. Paramètres de chemin d'accès] {#scim-GET-Departments__entry__6}{#scim-GET-Departments__attributes-SCIM-entry}{#scim-GET-Departments__count-SCIM-entry}{#scim-GET-Departments__excludedAttributes-SCIM-entry}{#scim-GET-Departments__group_sortBy-SCIM-entry}{#scim-GET-Departments__sortOrder-SCIM-entry}{#scim-GET-Departments__group_startIndex-SCIM-entry} | Nom | Description | |-|-| | attributs | Liste des champs séparés par des virgules à envoyer dans la réponse. Aucun autre champ n'est renvoyé. Ne peut pas être utilisé avec le excludedAttributes paramètre. Type de données : chaîne Par défaut : renvoie tous les champs sauf s'il excludedAttributes est spécifié. | | compter | Nombre d'enregistrements à renvoyer. Une valeur négative est interprétée comme zéro. Type de données : nombre Maximum : 500 : une valeur supérieure à cette valeur entraîne une erreur de demande incorrecte. Par défaut : 10 | | Attributs exclus | Liste de champs séparés par des virgules à exclure des enregistrements renvoyés dans la réponse. Tous les autres champs sont renvoyés. Ne peut pas être utilisé avec le attributes paramètre. Type de données : chaîne Par défaut : n'excluez aucun champ. | | filtre | Expression de filtre à appliquer aux résultats renvoyés. Les filtres de champ sont exprimés sous la forme ` <"valeur>`. Consultez [RFC7644](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2) pour obtenir la liste des opérateurs valides. Remarque : `L'opérateur NOT` n'est pas pris en charge par cette méthode. Par exemple, pour filtrer tous les départements dont le nom commence par \<\< Ingénieur \>\>, saisissez `displayName SW << Ingénieur` \>\>. Pour spécifier plusieurs filtres de champ, concaténez les filtres à l'aide de l'opérande `ET` . Par exemple, pour filtrer tous les départements dont le nom commence par \<\< Ingénieur \>\> et dont la dernière modification a été effectuée avant le 3 octobre 2021, saisissez `displayName SW << Ingénieur >> ET meta.lastModified lt << 2021-10-03T00:00:00Z >>.` Utilisez la remontée pas à pas pour spécifier les attributs imbriqués. Type de données : chaîne Par défaut : aucun filtrage | | trier par | Doit être spécifié avec le sortOrder paramètre. Champ utilisé pour trier les résultats renvoyés. Le tri n'est pas sensible à la casse. Vous ne pouvez utiliser que les paramètres disponibles pour le filtrage du sortBy paramètre, sauf si cela externalId n'est pas autorisé. Pour les valeurs nulles : * Trié par ordre croissant : les valeurs nulles sont triées tout en haut. * trié par ordre décroissant : les valeurs nulles sont triées en bas. {#scim-GET-Departments__ul_xsb_zmm_hrb} Type de données : chaîne Par défaut : aucun tri | | sortOrder | Doit être spécifié avec le sortBy paramètre. Ordre dans lequel le sortBy paramètre est appliqué aux résultats renvoyés. Valeurs valides : * ascendant * descendant {#scim-GET-Departments__ul_mmn_zrc_grb} Type de données : chaîne Par défaut : croissant | | startIndex | Index de base unique dans la table à partir de laquelle commencer à récupérer les enregistrements. Par exemple, si vous définissez ce paramètre sur 100 et le count paramètre sur 20, le point de terminaison renvoie les enregistrements 100 à 119. Remarque : Toute valeur qui est définie sur moins de un est interprétée comme un. Type de données : chaîne Valeur par défaut : 1 | [Tableau 140. Paramètres de requête] {#scim-GET-Departments__entry__22} | Nom | Description | |-|-| | Aucun | | [Tableau 141. Paramètres du corps de la demande (JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-GET-Departments__entry__26}{#scim-GET-Departments__Accept-SCIM-entry} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/scim+json. Valeur par défaut : application/json | [Tableau 142. En-têtes de demandes] {#scim-GET-Departments__entry__30} | En-tête | Description | |-|-| | Aucun | | [Tableau 143. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-GET-Departments__entry__34}{#scim-GET-Departments__entry-200-status-code}{#scim-GET-Departments__status_400-SCIM-entry}{#scim-GET-Departments__entry-401-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. * Assurez-vous que les paramètres de requête et excludedAttributes n'ont attributes pas été transmis dans la demande. * Assurez-vous que le paramètre n'est count pas supérieur à 500. * Assurez-vous que tous les filter paramètres sont valides. {#scim-GET-Departments__ul_vn1_gvz_nrb} | | 401 | Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises. | [Tableau 144. Codes d'état] ### Paramètres de corps de réponse (JSON) {#scim-GET-Departments__id_sqc_3br_3rb__entry__2}{#scim-GET-Departments__itemsPerPage-SCIM-entry}{#scim-GET-Departments__totalResults-SCIM-entry} | Nom | Description | |-|-| | itemsPerPage | Nombre d'enregistrements renvoyés dans les résultats renvoyés. Type de données : nombre | | Ressources | Liste des enregistrements de département renvoyés. Type de données : objet "Resources": { "id": "String", "meta": {Object}, "name": "String", "schemas": "String" } | | Resources.id | Sys_id de l'enregistrement du département. Type de données : chaîne | | Ressources.meta | Informations relatives à l'enregistrement du département. Type de données : objet "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" } | | Ressources.meta.créé | Date et heure de création de l'enregistrement du département associé. Type de données : chaîne | | Ressources.meta.lastModified | Date et heure de la dernière modification de l'enregistrement du département associé. Type de données : chaîne | | Ressources.meta.location | URI de l'enregistrement du département associé. Type de données : chaîne | | Resources.meta.resourceType | type de ressource SCIM ; toujours le département. Type de données : chaîne | | Resources.name | Nom de département. Type de données : chaîne | | Resources.schemas | | | Schémas | | | startIndex | Index à base unique dans la table Département \[cmn_department\] dans laquelle les enregistrements ont été renvoyés. Type de données : chaîne | | totalResults | Nombre total d'enregistrements qui correspondent à la demande. Type de données : nombre | [ ] {#scim-GET-Departments__id_sqc_3br_3rb} ### Demande cURL Cet exemple montre comment récupérer les deux premiers enregistrements de département. curl "https://instance-servicenow.com/api/now/scim/Departments?count=2" \ --request GET \ --header "Accept:application/scim+json" \ Réponse { "schemas":[ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ], "totalResults":7, "Resources":[ { "schemas":[ "urn:ietf:params:scim:schemas:custom:servicenow:2.0:Department" ], "id":"221db0edc611228401760aec06c9d929", "meta":{ "resourceType":"Department", "created":"2006-01-31T20:18:24Z", "lastModified":"2012-02-18T07:01:40Z", "location":"https://instance-servicenow.com/api/now/scim/Departments/221db0edc611228401760aec06c9d929" }, "name":"Sales" }, { "schemas":[ "urn:ietf:params:scim:schemas:custom:servicenow:2.0:Department" ], "id":"221f3db5c6112284009f4becd3039cc9", "meta":{ "resourceType":"Department", "created":"2008-03-20T20:20:06Z", "lastModified":"2012-02-18T07:01:22Z", "location":"https://instance-servicenow.com/api/now/scim/Departments/221f3db5c6112284009f4becd3039cc9" }, "name":"Development" } ], "startIndex":1, "itemsPerPage":2 } ## SCIM - GET /scim/Departments/{deparment_id} {#ariaid-title24} Renvoie l'enregistrement du département spécifié à partir de la table Département \[cmn_department\] au sein d'une ServiceNow instance utilisant le protocole SCIM (System for Inter-domain Identity Management). ### Format d'URL URL versionnée : /api/now/{api_version}/scim/Departments/{department_id} URL par défaut : /api/now/scim/Departments/{department_id} ### Paramètres de demande pris en charge {#scim-GET-Departments-department_id__entry__2}{#scim-GET-Departments-department_id__version-RESTAPI} | Nom | Description | |-|-| | api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne | | department_id | Sys_id de l'enregistrement du département à renvoyer. Type de données : chaîne | [Tableau 145. Paramètres de chemin d'accès] {#scim-GET-Departments-department_id__entry__8}{#scim-GET-Departments-department_id__attributes-SCIM-entry}{#scim-GET-Departments-department_id__excludedAttributes-SCIM-entry} | Nom | Description | |-|-| | attributs | Liste des champs séparés par des virgules à envoyer dans la réponse. Aucun autre champ n'est renvoyé. Ne peut pas être utilisé avec le excludedAttributes paramètre. Type de données : chaîne Par défaut : renvoie tous les champs sauf s'il excludedAttributes est spécifié. | | Attributs exclus | Liste de champs séparés par des virgules à exclure des enregistrements renvoyés dans la réponse. Tous les autres champs sont renvoyés. Ne peut pas être utilisé avec le attributes paramètre. Type de données : chaîne Par défaut : n'excluez aucun champ. | [Tableau 146. Paramètres de requête] {#scim-GET-Departments-department_id__entry__14} | Nom | Description | |-|-| | Aucun | | [Tableau 147. Paramètres du corps de la demande (JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-GET-Departments-department_id__entry__18}{#scim-GET-Departments-department_id__Accept-SCIM-entry} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/scim+json. Valeur par défaut : application/json | [Tableau 148. En-têtes de demandes] {#scim-GET-Departments-department_id__entry__22} | En-tête | Description | |-|-| | Aucun | | [Tableau 149. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-GET-Departments-department_id__entry__26}{#scim-GET-Departments-department_id__entry-200-status-code}{#scim-GET-Departments-department_id__status_400-SCIM-entry}{#scim-GET-Departments-department_id__entry-401-status-code}{#scim-GET-Departments-department_id__entry-404-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. * Assurez-vous que les paramètres de requête et excludedAttributes n'ont attributes pas été transmis dans la demande. * Assurez-vous que le paramètre n'est count pas supérieur à 500. * Assurez-vous que tous les filter paramètres sont valides. {#scim-GET-Departments-department_id__ul_vn1_gvz_nrb} | | 401 | Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises. | | 404 | Introuvable. L'élément demandé est introuvable. | [Tableau 150. Codes d'état] ### Paramètres de corps de réponse (JSON) {#scim-GET-Departments-department_id__id_g3b_jdr_3rb__entry__2}{#scim-GET-Departments-department_id__id-dept-SCIM-entry}{#scim-GET-Departments-department_id__meta-dept-SCIM-entry}{#scim-GET-Departments-department_id__meta_created-dept-SCIM-entry}{#scim-GET-Departments-department_id__meta_lastModified-dept-SCIM-entry}{#scim-GET-Departments-department_id__meta_location-dept-SCIM-entry}{#scim-GET-Departments-department_id__meta_resourceType-dept-SCIM-entry}{#scim-GET-Departments-department_id__name-dept-SCIM-entry}{#scim-GET-Departments-department_id__schemas-dept-SCIM-entry} | Nom | Description | |-|-| | id | Sys_id de l'enregistrement du département. Type de données : chaîne | | métadonnées | Informations relatives à l'enregistrement du département. Type de données : objet "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" } | | meta.created | Date et heure de création de l'enregistrement du département associé. Type de données : chaîne | | meta.lastModified | Date et heure de la dernière modification de l'enregistrement du département associé. Type de données : chaîne | | meta.location | URI de l'enregistrement du département associé. Type de données : chaîne | | meta.resourceType | type de ressource SCIM ; toujours le département. Type de données : chaîne | | nom | Nom de département. Type de données : chaîne | | Schémas | Schéma utilisé lors du traitement de la demande. Type de données : chaîne | [ ] {#scim-GET-Departments-department_id__id_g3b_jdr_3rb} ### Demande cURL Cet exemple montre comment récupérer un enregistrement de service spécifique. curl "https://instance-servicenow.com/api/now/scim/Departments/221db0edc611228401760aec06c9d929" \ --request GET \ --header "Accept:application/scim+json" \ Réponse : { "schemas":[ "urn:ietf:params:scim:schemas:custom:servicenow:2.0:Department" ], "id":"221db0edc611228401760aec06c9d929", "meta":{ "resourceType":"Department", "created":"2006-01-31T20:18:24Z", "lastModified":"2012-02-18T07:01:40Z", "location":"https://instance-servicenow.com/api/now/scim/Departments/221db0edc611228401760aec06c9d929" }, "name":"Sales" } ## SCIM - GET /scim/Emplacements {#ariaid-title25} Renvoie un ou plusieurs enregistrements d'emplacement de la table Emplacement \[cmn_location\] au sein d'une ServiceNow instance utilisant le protocole SCIM (System for Cross-domain Identity Management). Remarque : Une requête qui ne renvoie aucune correspondance renvoie un message de réussite (code d'état HTTP 200) avec totalResults la valeur 0. ### Format d'URL URL versionnée : /api/now/{api_version}/scim/Locations URL par défaut : /api/now/scim/Locations ### Paramètres de demande pris en charge {#scim-GET-Locations__entry__2}{#scim-GET-Locations__version-RESTAPI} | Nom | Description | |-|-| | api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne | [Tableau 151. Paramètres de chemin d'accès] {#scim-GET-Locations__entry__6}{#scim-GET-Locations__attributes-SCIM-entry}{#scim-GET-Locations__count-SCIM-entry}{#scim-GET-Locations__excludedAttributes-SCIM-entry}{#scim-GET-Locations__group_sortBy-SCIM-entry}{#scim-GET-Locations__sortOrder-SCIM-entry}{#scim-GET-Locations__group_startIndex-SCIM-entry} | Nom | Description | |-|-| | attributs | Liste des champs séparés par des virgules à envoyer dans la réponse. Aucun autre champ n'est renvoyé. Ne peut pas être utilisé avec le excludedAttributes paramètre. Type de données : chaîne Par défaut : renvoie tous les champs sauf s'il excludedAttributes est spécifié. | | compter | Nombre d'enregistrements à renvoyer. Une valeur négative est interprétée comme zéro. Type de données : nombre Maximum : 500 : une valeur supérieure à cette valeur entraîne une erreur de demande incorrecte. Par défaut : 10 | | Attributs exclus | Liste de champs séparés par des virgules à exclure des enregistrements renvoyés dans la réponse. Tous les autres champs sont renvoyés. Ne peut pas être utilisé avec le attributes paramètre. Type de données : chaîne Par défaut : n'excluez aucun champ. | | filtre | Expression de filtre à appliquer aux résultats renvoyés. Les filtres de champ sont exprimés sous la forme ` <"valeur>`. Consultez [RFC7644](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2) pour obtenir la liste des opérateurs valides. Remarque : `L'opérateur NOT` n'est pas pris en charge par cette méthode. Par exemple, pour filtrer tous les emplacements dont le nom commence par \<\< Ch \>\>, saisissez `displayName SW << Ch >>.` Pour spécifier plusieurs filtres de champ, concaténez les filtres à l'aide de l'opérande `ET` . Par exemple, pour filtrer tous les emplacements dont le nom commence par \<\< Ch \>\> et dont la dernière modification a été effectuée avant le 3 octobre 2021, saisissez `displayName SW << Ch >> AND meta.lastModified lt << 2021-10-03T00:00:00Z >>.` Utilisez la remontée pas à pas pour spécifier les attributs imbriqués. Type de données : chaîne Par défaut : aucun filtrage | | trier par | Doit être spécifié avec le sortOrder paramètre. Champ utilisé pour trier les résultats renvoyés. Le tri n'est pas sensible à la casse. Vous ne pouvez utiliser que les paramètres disponibles pour le filtrage du sortBy paramètre, sauf si cela externalId n'est pas autorisé. Pour les valeurs nulles : * Trié par ordre croissant : les valeurs nulles sont triées tout en haut. * trié par ordre décroissant : les valeurs nulles sont triées en bas. {#scim-GET-Locations__ul_xsb_zmm_hrb} Type de données : chaîne Par défaut : aucun tri | | sortOrder | Doit être spécifié avec le sortBy paramètre. Ordre dans lequel le sortBy paramètre est appliqué aux résultats renvoyés. Valeurs valides : * ascendant * descendant {#scim-GET-Locations__ul_mmn_zrc_grb} Type de données : chaîne Par défaut : croissant | | startIndex | Index de base unique dans la table à partir de laquelle commencer à récupérer les enregistrements. Par exemple, si vous définissez ce paramètre sur 100 et le count paramètre sur 20, le point de terminaison renvoie les enregistrements 100 à 119. Remarque : Toute valeur qui est définie sur moins de un est interprétée comme un. Type de données : chaîne Valeur par défaut : 1 | [Tableau 152. Paramètres de requête] {#scim-GET-Locations__entry__22} | Nom | Description | |-|-| | Aucun | | [Tableau 153. Paramètres du corps de la demande (JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-GET-Locations__entry__26}{#scim-GET-Locations__Accept-SCIM-entry} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/scim+json. Valeur par défaut : application/json | [Tableau 154. En-têtes de demandes] {#scim-GET-Locations__entry__30} | En-tête | Description | |-|-| | Aucun | | [Tableau 155. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-GET-Locations__entry__34}{#scim-GET-Locations__entry-200-status-code}{#scim-GET-Locations__status_400-SCIM-entry}{#scim-GET-Locations__entry-401-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. * Assurez-vous que les paramètres de requête et excludedAttributes n'ont attributes pas été transmis dans la demande. * Assurez-vous que le paramètre n'est count pas supérieur à 500. * Assurez-vous que tous les filter paramètres sont valides. {#scim-GET-Locations__ul_vn1_gvz_nrb} | | 401 | Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises. | [Tableau 156. Codes d'état] ### Paramètres de corps de réponse (JSON) {#scim-GET-Locations__id_qt1_xfr_3rb__entry__2}{#scim-GET-Locations__itemsPerPage-SCIM-entry}{#scim-GET-Locations__totalResults-SCIM-entry} | Nom | Description | |-|-| | itemsPerPage | Nombre d'enregistrements renvoyés dans les résultats renvoyés. Type de données : nombre | | Ressources | Liste des enregistrements d'emplacement renvoyés. Type de données : objet "Resources": { "id": "String", "meta": {Object}, "name": "String", "schemas": "String" } | | Resources.id | Sys_id de l'enregistrement de l'emplacement. Type de données : chaîne | | Ressources.meta | Informations relatives à l'enregistrement de l'emplacement. Type de données : objet "meta": { "created": "String", "lastModified": "String", "location": "String", "resourceType": "String" } | | Ressources.meta.créé | Date et heure de création de l'enregistrement d'emplacement associé. Type de données : chaîne | | Ressources.meta.lastModified | Date et heure de la dernière modification de l'enregistrement d'emplacement associé. Type de données : chaîne | | Ressources.meta.location | URI de l'enregistrement d'emplacement associé. Type de données : chaîne | | Resources.meta.resourceType | type de ressource SCIM ; toujours l'emplacement. Type de données : chaîne | | Resources.name | Nom de l'emplacement. Type de données : chaîne | | Resources.schemas | Schéma utilisé lors du traitement de la demande. Type de données : chaîne | | Schémas | Schéma utilisé pour traiter la réponse de liste à la demande. Par exemple : `<< urn :ietf :params :scim :api :messages :2.0 :ListResponse >>` Type de données : chaîne | | startIndex | Index de base unifiée dans la table Emplacement \[cmn_location\] dans laquelle les enregistrements ont été renvoyés. Type de données : chaîne | | totalResults | Nombre total d'enregistrements qui correspondent à la demande. Type de données : nombre | [ ] {#scim-GET-Locations__id_qt1_xfr_3rb} ### Demande cURL Cet exemple montre comment récupérer les deux premiers enregistrements de société. curl "https://instance-servicenow.com/api/now/scim/Locations?count=2" \ --request GET \ --header "Accept:application/scim+json" \ Réponse { "schemas":[ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ], "totalResults":426, "Resources":[ { "schemas":["urn:ietf:params:scim:schemas:custom:servicenow:2.0:Location"], "id":"0002c0a93790200044e0bfc8bcbe5df5", "meta":{ "resourceType":"Location", "created":"2012-02-19T18:39:00Z", "lastModified":"2012-02-19T18:39:00Z", "location":"https://instance-servicenow.com/api/now/scim/Locations/0002c0a93790200044e0bfc8bcbe5df5" }, "name":"2-10-1 Yurakucho, Chiyoda-ku, Tokyo" }, { "schemas":["urn:ietf:params:scim:schemas:custom:servicenow:2.0:Location"], "id":"0594ed7437d0200044e0bfc8bcbe5df0", "meta":{ "resourceType":"Location", "created":"2012-02-17T17:54:15Z", "lastModified":"2021-08-31T14:13:11Z", "location":"https://instance-servicenow.com/api/now/scim/Locations/0594ed7437d0200044e0bfc8bcbe5df0" }, "name":"Colombia" } ], "startIndex":1, "itemsPerPage":2 } ## SCIM - GET /scim/Locations/{location_id} {#ariaid-title26} Renvoie l'enregistrement d'emplacement spécifié à partir de la table Emplacement \[cmn_location\] au sein d'une ServiceNow instance utilisant le protocole SCIM (System for Cross-domain Identity Management). ### Format d'URL URL versionnée : /api/now/{api_version}/scim/Locations/{location_id} URL par défaut : /api/now/scim/Locations/{location_id} ### Paramètres de demande pris en charge {#scim-GET-Locations-location_id__entry__2}{#scim-GET-Locations-location_id__version-RESTAPI} | Nom | Description | |-|-| | api_version | Facultatif. Version du point de terminaison auquel accéder. Exemple : v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne | | location_id | Sys_id de l'enregistrement d'emplacement à renvoyer. Type de données : chaîne | [Tableau 157. Paramètres de chemin d'accès] {#scim-GET-Locations-location_id__entry__8}{#scim-GET-Locations-location_id__attributes-SCIM-entry}{#scim-GET-Locations-location_id__excludedAttributes-SCIM-entry} | Nom | Description | |-|-| | attributs | Liste des champs séparés par des virgules à envoyer dans la réponse. Aucun autre champ n'est renvoyé. Ne peut pas être utilisé avec le excludedAttributes paramètre. Type de données : chaîne Par défaut : renvoie tous les champs sauf s'il excludedAttributes est spécifié. | | Attributs exclus | Liste de champs séparés par des virgules à exclure des enregistrements renvoyés dans la réponse. Tous les autres champs sont renvoyés. Ne peut pas être utilisé avec le attributes paramètre. Type de données : chaîne Par défaut : n'excluez aucun champ. | [Tableau 158. Paramètres de requête] {#scim-GET-Locations-location_id__entry__14} | Nom | Description | |-|-| | Aucun | | [Tableau 159. Paramètres du corps de la demande (JSON)] ### En-têtes Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-GET-Locations-location_id__entry__18}{#scim-GET-Locations-location_id__Accept-SCIM-entry} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/scim+json. Valeur par défaut : application/json | [Tableau 160. En-têtes de demandes] {#scim-GET-Locations-location_id__entry__22} | En-tête | Description | |-|-| | Aucun | | [Tableau 161. En-têtes de réponses] ### Codes d'état Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#scim-GET-Locations-location_id__entry__26}{#scim-GET-Locations-location_id__entry-200-status-code}{#scim-GET-Locations-location_id__status_400-SCIM-entry}{#scim-GET-Locations-location_id__entry-401-status-code}{#scim-GET-Locations-location_id__entry-404-status-code} | Code d'état | Description | |-|-| | 200 | Réussi. La demande a été correctement traitée. | | 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. * Assurez-vous que les paramètres de requête et excludedAttributes n'ont attributes pas été transmis dans la demande. * Assurez-vous que le paramètre n'est count pas supérieur à 500. * Assurez-vous que tous les filter paramètres sont valides. {#scim-GET-Locations-location_id__ul_vn1_gvz_nrb} | | 401 | Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises. | | 404 | Introuvable. L'élément demandé est introuvable. | [Tableau 162. Codes d'état] ### Paramètres de corps de réponse (JSON) {#scim-GET-Locations-location_id__id_s2d_33r_3rb__entry__2}{#scim-GET-Locations-location_id__id-location-SCIM-entry}{#scim-GET-Locations-location_id__meta-location-SCIM-entry}{#scim-GET-Locations-location_id__meta_created-location-SCIM-entry}{#scim-GET-Locations-location_id__meta_lastModified-location-SCIM-entry}{#scim-GET-Locations-location_id__meta_location-location-SCIM-entry}{#scim-GET-Locations-location_id__meta_resourceType-location-SCIM-entry}{#scim-GET-Locations-location_id__name-location-SCIM-entry}{#scim-GET-Locations-location_id__schemas-location-SCIM-entry} | Nom | Description | |-|-| | id | Sys_id de l'enregistrement de l'emplacement. Type de données : chaîne | | métadonnées | Informations relatives à l'enregistrement de l'emplacement. Type de données : objet "meta": { "created": "String", "lastModified": "String", "location": "String", "resourceType": "String" } | | meta.created | Date et heure de création de l'enregistrement d'emplacement associé. Type de données : chaîne | | meta.lastModified | Date et heure de la dernière modification de l'enregistrement d'emplacement associé. Type de données : chaîne | | meta.location | URI de l'enregistrement d'emplacement associé. Type de données : chaîne | | meta.resourceType | type de ressource SCIM ; toujours l'emplacement. Type de données : chaîne | | nom | Nom de l'emplacement. Type de données : chaîne | | Schémas | Schéma utilisé lors du traitement de la demande. Type de données : chaîne | [ ] {#scim-GET-Locations-location_id__id_s2d_33r_3rb} ### Demande cURL Cet exemple montre comment récupérer un enregistrement d'emplacement spécifique. curl "https://instance-servicenow.com/api/now/scim/Locations/0c43af40c6112275011a4bd4c0143fbf" \ --request GET \ --header "Accept:application/scim+json" \ Réponse { "schemas":["urn:ietf:params:scim:schemas:custom:servicenow:2.0:Location"], "id":"0594ed7437d0200044e0bfc8bcbe5df0", "meta":{ "resourceType":"Location", "created":"2012-02-17T17:54:15Z", "lastModified":"2021-08-31T14:13:11Z", "location":"https://instance-servicenow.com/api/now/scim/Locations/0594ed7437d0200044e0bfc8bcbe5df0" }, "name":"Colombia" }