API du système de gestion des identités inter-domaines (SCIM)

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 des utilisateurs et des groupes à l’aide du protocole SCIM.

Le protocole SCIM est un protocole HTTP au niveau de l’application basé sur la norme HTTP [RFC7230]. Utilisez cette API pour la mise en service et la gestion des données d’identité, telles que les utilisateurs et les groupes, sur le Web et dans des environnements interdomaines, tels que les fournisseurs de services d’entreprise à cloud ou les scénarios intercloud.

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)
• Entreprise
• CostCenter
• Département
• Emplacement

La plupart des attributs de ces ressources SCIM sont mappés aux champs correspondants d’une table existante ServiceNow . Les tableaux suivants 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, consultez Tables spécifiques à SCIM.

La ressource Utilisateur SCIM possède des schémas de base (schema : 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 du schéma principal de l’utilisateur et du schéma d’extension sont mappés à la table Utilisateur [sys_user].

Tableau 1. Mappage de ressource utilisateur à table d’utilisateur [sys_user]

Nom de l’attribut SCIM	Nom du 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
adresses.postalCode	code postal
adresses.default.postalCode	code postal
adresses.home.postalCode	code postal
Adresses.Région	État
adresses.default.region	État
adresses.accueil.région	État
adresses.adresses.rue	rue
adresses.default.rueAdresse	rue
adresses.domicile.adresse_rue	rue
displayName	nom
emails.value	E-mail
e-mails.valeur.default.	E-mail
emails.work.value	E-mail
id	sys_id
méta.créé	sys_created_on
méta.lastModified	sys_updated_on
nom.familyName	last_name
nom.prénom	first_name
nom.honorificPrefix	Introduction
nom.deuxième prénom	middle_name
phoneNumbers.value	Téléphone
phoneNumbers.home.value	home_phone
phoneNumbers.mobile.value	mobile_phone
NumérosTéléphone.travail.valeur	Téléphone
preferredLanguage	preferred_language
fuseau horaire	time_zone
Titre	Titre
userName	user_name

Tableau 2. Mappage de la ressource utilisateur vers la table de l’utilisateur Sys Scim [sys_scim_user]

Nom de l’attribut SCIM	Nom du champ d’utilisateur Sys Scim
externalId	external_id

Le schéma étendu d’utilisateur SCIM (urn :ietf :params :scim :schemas :extension :servicenow :2.0 :User) est mappé à la table Utilisateur [sys_user].

Tableau 3. Mappage de la ressource étendue de l’utilisateur à la table d’utilisateur [sys_user]

Nom de l’attribut SCIM	Nom du champ d’utilisateur
company.name	company.name
entreprise.valeur	company.sys_id
costCenter.name	cost_center.nom
costCenter.valeur	cost_center.sys_id
department.name	department.name
service.valeur	department.sys_id
Numéro d’employé	employee_number
sexe	sexe
location.name	location.name
valeur.emplacement	location.sys_id
manager.displayName	manager.name
manager.value	manager.sys_id

Le schéma de ressource Groupe SCIM (urn :ietf :params :scim :schemas :core :2.0 :Group) est mappé à la table Groupe [sys_user_group].

Tableau 4. Mappage de ressource de groupe à table de groupe [sys_user_group]

Nom de l’attribut SCIM	Nom de champ de groupe
displayName	nom
id	sys_id
méta.créé	sys_created_on
méta.lastModified	sys_updated_on

Le paramètre externalId du groupe SCIM est mappé à la table Groupe Sys Scim [sys_scim_group].

Tableau 5. Mappage de ressource de groupe vers la table du groupe Sys Scim [sys_scim_group]

Nom de l’attribut SCIM	Nom de champ du groupe Sys Scim
externalId	external_id

Le schéma d’extension Groupe ServiceNow SCIM (urn :ietf :params :scim :schemas :extension :servicenow :2.0 :Group) est mappé à la table Groupe [sys_user_group].

Tableau 6. Mappage de ressource de groupe à table de groupe [sys_user_group]

Nom de l’attribut SCIM	Nom de champ de groupe
entreprise.valeur	company.sys_id
company.name	company.name

Le schéma de ressource Société SCIM (urn :ietf :params :scim :schemas :custom :servicenow :2.0 :Company) est mappé à la table Société [core_company].

Tableau 7. Mappage des ressources de l’entreprise vers la table de société [core_company]

Nom de l’attribut SCIM	Nom du champ de société
id	sys_id
méta.créé	sys_created_on
méta.lastModified	sys_updated_on
nom	nom

Le schéma de ressource SCIM Centre de coûts (urn :ietf :params :scim :schemas :custom :servicenow :2.0 :CostCenter) est mappé à la table Centre de coûts [cmn_cost_center].

Tableau 8. Mappage des ressources CostCenter vers la table Centre de coûts [cmn_cost_center]

Nom de l’attribut SCIM	Nom du champ du centre de coûts
id	sys_id
méta.créé	sys_created_on
méta.lastModified	sys_updated_on
nom	nom

Le schéma de ressources Département SCIM (urn :ietf :params :scim :schemas :custom :servicenow :2.0 :Department) est mappé à la table Département [cmn_department].

Tableau 9. Mappage de la ressource du département à la table du département [cmn_department]

Nom de l’attribut SCIM	Nom de champ du département
id	sys_id
méta.créé	sys_created_on
méta.lastModified	sys_updated_on
nom	nom

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].

Tableau 10. Mappage d’une ressource d’emplacement à une table d’emplacement [cmn_location]

Nom de l’attribut SCIM	Nom du champ d’emplacement
id	sys_id
méta.créé	sys_created_on
méta.lastModified	sys_updated_on
nom	nom

Tables spécifiques SCIM

Deux tables, Utilisateur Sys Scim [sys_scim_user] et Groupe Sys Scim [sys_scim_group], contiennent les attributs SCIM qui ne sont pas mappés aux tables existantes ServiceNow . Le contenu de ces tables est défini comme suit.

Tableau 11. Table d’utilisateur Sys Scim [sys_scim_user]

Nom de champ	Description
Créées	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 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 de l’enregistrement dans 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 pour la dernière fois l’enregistrement associé. Type de données : chaîne Longueur maximale : 40
Mises à jour	Nombre de fois où l’enregistrement a été mis à jour. Type de données : nombre (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 Temporaire Inconnu Type de données : chaîne Longueur maximale : 40

Tableau 12. Table du groupe Sys Scim [sys_scim_group]

Nom de champ	Description
Créées	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 du groupe [sys_user_group] Longueur maximale : 32
ID système	Identificateur unique de l’enregistrement dans 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 pour la dernière fois l’enregistrement associé. Type de données : chaîne Longueur maximale : 40
Mises à jour	Nombre de fois où l’enregistrement a été mis à jour. Type de données : nombre (entier) Longueur maximale : 40

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 permettant d’accéder à la table Utilisateur Sys Scim [sys_scim_user] et à la table Groupe Sys Scim [sys_scim_group] qui permettent la création, la suppression, la lecture et l’écriture. Ces ACL sont uniquement mappées au rôle scim_admin.

SCIM : SUPPRIMER /scim/Groups/{group_id}

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}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 13. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par 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 à supprimer. Type de données : chaîne Table : Groupe [sys_user_group]

Tableau 14. Paramètres de requête

Nom	Description
Néant

Tableau 15. Paramètres du corps de la demande (JSON)

Nom	Description
Néant

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.

Tableau 16. En-têtes de demandes

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 17. En-têtes de réponses

En-tête	Description
Aucun

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.

Tableau 18. Codes d'état

Code d'état	Description
204	Aucun contenu. La demande a été correctement traitée.
404	Introuvable. L’élément demandé est introuvable.

Paramètres de corps de réponse (JSON)

Nom	Description
erreurs	Réponse qui décrit toutes les erreurs qui ont pu se produire pendant le traitement de la demande. Type de données : objet "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" }
Erreur.Détail	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
Erreur.État	Code d’état HTTP de la réponse d’erreur. Type de données : chaîne

Demande cURL pour supprimer 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

Renvoie un ou plusieurs enregistrements de groupe de la table Groupe [sys_user_group] au sein d’une ServiceNow instance à l’aide du 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

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 19. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par 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 20. Paramètres de requête

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 indication excludedAttributes contraire.
compter	Nombre d’enregistrements à renvoyer. Une valeur négative est interprétée comme nulle. Type de données : nombre Maximum : 500 : une valeur supérieure à cette valeur entraîne une erreur de demande incorrecte. Valeur par défaut : 10
excludedAttributes	Liste séparée par des virgules des champs à 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’exclut aucun champ.
filtre	Expression de filtre à appliquer aux résultats de retour. Les filtres de champ sont exprimés sous la forme <field_name> <opérateur> <"valeur">. Consultez RFC7644 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 », saisissez displayName SW « HR ». 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 qui ont été modifiés pour la dernière fois avant le 3 octobre 2021, saisissez displayName SW « HR » et meta.lastModified lt « 2021-10-33T00:00:00Z ». Utilisez une 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 : prend uniquement en charge l’opérateur EQ . id méta.créé méta.lastModified Type de données : chaîne Par défaut : aucun filtrage
sortBy	Doit être spécifié avec le sortOrder paramètre. Champ selon lequel trier les résultats renvoyés. Le tri est insensible à la casse. Vous ne pouvez utiliser que les paramètres disponibles pour le filtrage du paramètre, sauf si cela externalId n’est sortBy pas autorisé. Pour les valeurs qui sont nulles : trié par ordre croissant : les valeurs nulles sont triées vers le haut. trié par ordre décroissant : les valeurs nulles sont triées vers le bas. 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 de retour. Valeurs valides : ascendant descendant Type de données : chaîne Par défaut : croissant
startIndex	Index basé sur un dans la table à laquelle commencer la récupération 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 définie sur une valeur inférieure à un est interprétée comme un. Type de données : chaîne Valeur par défaut : 1

Tableau 21. Paramètres du corps de la demande (JSON)

Nom	Description
Néant

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.

Tableau 22. En-têtes de demandes

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 23. En-têtes de réponses

En-tête	Description
Aucun

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.

Tableau 24. Codes d'état

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.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.

Paramètres de corps de réponse (JSON)

Nom	Description
itemsPerPage	Nombre d’enregistrements renvoyés dans les résultats renvoyés. Type de données : nombre
Ressources	Liste des enregistrements de groupes. Type de données : tableau d’objets "Resources": [ { "company": {Object}, "displayName": "String", "externalId": "String", "id": "String", "meta": [Array] } ]
Ressources.entreprise	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 : <host>/Companies/<company sys_id>, tel que : 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
Ressources.nom_affichage	Nom explicite du groupe, par exemple Équipe RH. Type de données : chaîne
Ressources.Identificateurexterne	Identificateur unique affecté au groupe par l’entité qui le met en service. 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.méta.créées	Date et heure de création de l’enregistrement de groupe. Type de données : chaîne
Ressources.méta.lastModified	Date et heure auxquelles l’enregistrement de groupe a été modifié pour la dernière fois. Type de données : chaîne
Ressources.meta.emplacement	URI du groupe en cours de récupération. Type de données : chaîne
Ressources.méta.TypeRessources	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 de l’utilisateur ou du groupe associé. Type de données : chaîne
Ressources.membres.$ref	URI du membre du groupe associé. Type de données : chaîne
Ressources.schémas	Liste des URI des schémas de groupe SCIM 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 documenthttps://datatracker.ietf.org/doc/html/rfc7643#section-4.2 de schéma de base de l’Internet Engineering Task Force System for Cross-domain Identity Management. () urn :ietf :params :scim :schemas :extension :servicenow :2.0 :Group : ServiceNow schéma d’extension. 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 ne font pas partie du schéma de base. 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. 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] à 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 à l’aide de excludedAttributes

Cet exemple montre comment demander plusieurs groupes (quatre dans ce cas), en utilisant le count paramètre et en excluant les champs méta et membres.

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}

Renvoie l’enregistrement de groupe spécifié de la table Groupe [sys_user_group] au sein 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}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 25. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par 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 à renvoyer.

Tableau 26. Paramètres de requête

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 indication excludedAttributes contraire.
excludedAttributes	Liste séparée par des virgules des champs à 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’exclut aucun champ.

Tableau 27. Paramètres du corps de la demande (JSON)

Nom	Description
Néant

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.

Tableau 28. En-têtes de demandes

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 29. En-têtes de réponses

En-tête	Description
Aucun

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.

Tableau 30. Codes d'état

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.
404	Introuvable. L’élément demandé est introuvable.

Paramètres de corps de réponse (JSON)

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" }
company.display	Nom de la société. Type de données : chaîne
société.$ref	URI de référence de la société. Format : <host>/Companies/<company sys_id>, tel que : 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 met en service. 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" }
méta.créé	Date et heure de création de l’enregistrement de groupe. Type de données : chaîne
méta.lastModified	Date et heure auxquelles l’enregistrement de groupe a été modifié pour la dernière fois. Type de données : chaîne
méta.emplacement	URI du groupe en cours de récupération. Type de données : chaîne
méta.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" } ]
members.display	Nom du membre du groupe associé. Type de données : chaîne
membres.valeur	Sys_id de l’enregistrement de l’utilisateur ou du groupe associé. Type de données : chaîne
membres.$ref	URI du membre du groupe associé. Type de données : chaîne
Schémas	Liste des URI des schémas de groupe SCIM 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 documenthttps://datatracker.ietf.org/doc/html/rfc7643#section-4.2 de schéma de base de l’Internet Engineering Task Force System for Cross-domain Identity Management. () urn :ietf :params :scim :schemas :extension :servicenow :2.0 :Group : ServiceNow schéma d’extension. 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 ne font pas partie du schéma de base. 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. Type de données : tableau de chaînes

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 : CORRECTIF /scim/Groups/{group_id}

Vous permet d’ajouter, de mettre à jour et de supprimer des champs spécifiés dans un enregistrement de groupe de la table Groupe [sys_user_group] d’une ServiceNow instance à l’aide du protocole SCIM (System for Cross-domain Identity Management).

Pour plus d’informations, reportez-vous à la section Modification avec PATCH 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

Tableau 31. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par 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 à mettre à jour. Type de données : chaîne Table : Groupe [sys_user_group]

Tableau 32. Paramètres de requête

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 indication excludedAttributes contraire.
excludedAttributes	Liste séparée par des virgules des champs à 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’exclut aucun champ.

Tableau 33. Paramètres du corps de la demande (JSON)

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 de groupe. supprimer : supprimer la valeur du champ spécifié. Remplacé par le type de données « null ». remplacer : remplace la valeur du champ spécifié. Type de données : chaîne
Operations.path	Requis 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"] { "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.
Opérations.valeur	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 champ est exprimé sous forme value de chaîne. "Operations": [ { "op": "add", "path": "displayName", "value": "HR Group" } ] Vous pouvez également déclarer des path valeurs de chaîne simples sans paramètres, tels que : "Operations": [ { "op": "add", "value": { "displayName": "HR Group" } } ] L’élément suivant montre comment ajouter un membre au groupe : { "op": "add", "value": { "members": { "value": "62826bf03710200044e0bfc8bcbe5df1", } } } Si le champ en cours de mise à jour n’est pas dans le schéma de base, vous devez placer la paire nom-valeur dans un objet qui spécifie l’URN du schéma associé. "value": { "<schema_urn>": { "<field_name>": "<new_value>" }, } Par exemple : "value": { "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group": { "groupNumber": "13454" }, } Type de données : N’importe lequel
Opérations.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

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.

Tableau 34. En-têtes de demandes

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 35. En-têtes de réponses

En-tête	Description
Aucun

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.

Tableau 36. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
204	Réussi. Aucun contenu (applicable uniquement à l’API du correctif du groupe SCIM) : cet état 204 dépend de l’état de la propriété de l’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 conformément à la RFC : https://www.rfc-editor.org/rfc/rfc7644#page-35. Valeur de propriété par défaut : false La réponse d’API de correctif de groupe sans la propriété de contenu peut être utilisée pour obtenir des gains supplémentaires en termes de performances d’exécution de réponse 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é. Rechercher les valeurs non valides : Corps de demande mal formé. Le champ obligatoire n’est pas fourni ou vide. Une sys_id d’utilisateur ou de groupe non valide est fournie. 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.
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.

Paramètres de corps de réponse (JSON)

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" }
company.display	Nom de la société. Type de données : chaîne
société.$ref	URI de référence de la société. Format : <host>/Companies/<company sys_id>, tel que : 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 met en service. Type de données : chaîne
erreurs	Réponse qui décrit toutes les erreurs qui ont pu se produire pendant le traitement de la demande. Type de données : objet "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" }
Erreur.Détail	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
Erreur.É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 met en service. 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" } ]
members.display	Nom du membre du groupe associé. Type de données : chaîne
membres.valeur	Sys_id de l’enregistrement de l’utilisateur ou du groupe associé. Type de données : chaîne
membres.$ref	URI du membre du 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" }
méta.créé	Date et heure de création de l’enregistrement de groupe. Type de données : chaîne
méta.lastModified	Date et heure auxquelles l’enregistrement de groupe a été modifié pour la dernière fois. Type de données : chaîne
méta.emplacement	URI du groupe en cours de récupération. Type de données : chaîne
méta.resourceType	Type de ressource des groupes SCIM. Type de données : chaîne
Schémas	Liste des URI des schémas de groupe SCIM 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 documenthttps://datatracker.ietf.org/doc/html/rfc7643#section-4.2 de schéma de base de l’Internet Engineering Task Force System for Cross-domain Identity Management. () urn :ietf :params :scim :schemas :extension :servicenow :2.0 :Group : ServiceNow schéma d’extension. 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 ne font pas partie du schéma de base. 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. 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 associés (utilisateurs).

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 : PUBLIER /scim/Groups

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, telles qu’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

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 37. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par 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 38. Paramètres de requête

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 indication excludedAttributes contraire.
excludedAttributes	Liste séparée par des virgules des champs à 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’exclut aucun champ.

Tableau 39. Paramètres du corps de la demande (JSON)

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" }
company.display	Nom de la société. Type de données : chaîne
société.$ref	URI de référence de la société. Format : <host>/Companies/<company sys_id>, tel que : 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 met en service. 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 de l’utilisateur ou du groupe associé. Type de données : chaîne
Schémas	Requis. Liste des URI des schémas de groupe SCIM 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 documenthttps://datatracker.ietf.org/doc/html/rfc7643#section-4.2 de schéma de base de l’Internet Engineering Task Force System for Cross-domain Identity Management. () urn :ietf :params :scim :schemas :extension :servicenow :2.0 :Group : ServiceNow schéma d’extension. 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 ne font pas partie du schéma de base. 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. Type de données : tableau de chaînes

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.

Tableau 40. En-têtes de demandes

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 41. En-têtes de réponses

En-tête	Description
Aucun

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.

Tableau 42. Codes d'état

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é. Rechercher les valeurs non valides : Corps de demande mal formé. Le champ obligatoire n’est pas fourni ou vide. Une sys_id d’utilisateur ou de groupe non valide est fournie. 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.
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.

Paramètres de corps de réponse (JSON)

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" }
company.display	Nom de la société. Type de données : chaîne
société.$ref	URI de référence de la société. Format : <host>/Companies/<company sys_id>, tel que : 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 met en service. 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" }
méta.créé	Date et heure de création de l’enregistrement de groupe. Type de données : chaîne
méta.lastModified	Date et heure auxquelles l’enregistrement de groupe a été modifié pour la dernière fois. Type de données : chaîne
méta.emplacement	URI du groupe en cours de récupération. Type de données : chaîne
méta.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" } ]
members.display	Nom du membre du groupe associé. Type de données : chaîne
membres.valeur	Sys_id de l’enregistrement de l’utilisateur ou du groupe associé. Type de données : chaîne
membres.$ref	URI du membre du groupe associé. Type de données : chaîne
Schémas	Liste des URI des schémas de groupe SCIM 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 documenthttps://datatracker.ietf.org/doc/html/rfc7643#section-4.2 de schéma de base de l’Internet Engineering Task Force System for Cross-domain Identity Management. () urn :ietf :params :scim :schemas :extension :servicenow :2.0 :Group : ServiceNow schéma d’extension. 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 ne font pas partie du schéma de base. 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. Type de données : tableau de chaînes

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}

Met à jour l’enregistrement de groupe spécifié dans la table Groupe [sys_user_group] d’une ServiceNow instance à l’aide du 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}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 43. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par 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 à mettre à jour. Type de données : chaîne Table : Groupe [sys_user_group]

Tableau 44. Paramètres de requête

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 indication excludedAttributes contraire.
excludedAttributes	Liste séparée par des virgules des champs à 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’exclut aucun champ.

Tableau 45. Paramètres du corps de la demande (JSON)

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" }
company.display	Nom de la société. Type de données : chaîne
société.$ref	URI de référence de la société. Format : <host>/Companies/<company sys_id>, tel que : 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 met en service. 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 de l’utilisateur ou du groupe associé. Type de données : chaîne
Schémas	Requis. Liste des URI des schémas de groupe SCIM 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 documenthttps://datatracker.ietf.org/doc/html/rfc7643#section-4.2 de schéma de base de l’Internet Engineering Task Force System for Cross-domain Identity Management. () urn :ietf :params :scim :schemas :extension :servicenow :2.0 :Group : ServiceNow schéma d’extension. 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 ne font pas partie du schéma de base. 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. Type de données : tableau de chaînes

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.

Tableau 46. En-têtes de demandes

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 47. En-têtes de réponses

En-tête	Description
Aucun

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.

Tableau 48. Codes d'état

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é. Rechercher les valeurs non valides : Corps de demande mal formé. Le champ obligatoire n’est pas fourni ou vide. Une sys_id d’utilisateur ou de groupe non valide est fournie. 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.
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.

Paramètres de corps de réponse (JSON)

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" }
company.display	Nom de la société. Type de données : chaîne
société.$ref	URI de référence de la société. Format : <host>/Companies/<company sys_id>, tel que : 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 qui décrit toutes les erreurs qui ont pu se produire pendant le traitement de la demande. Type de données : objet "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" }
Erreur.Détail	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
Erreur.É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 met en service. 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" } ]
members.display	Nom du membre du groupe associé. Type de données : chaîne
membres.valeur	Sys_id de l’enregistrement de l’utilisateur ou du groupe associé. Type de données : chaîne
membres.$ref	URI du membre du 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" }
méta.créé	Date et heure de création de l’enregistrement de groupe. Type de données : chaîne
méta.lastModified	Date et heure auxquelles l’enregistrement de groupe a été modifié pour la dernière fois. Type de données : chaîne
méta.emplacement	URI du groupe en cours de récupération. Type de données : chaîne
méta.resourceType	Type de ressource des groupes SCIM. Type de données : chaîne
Schémas	Liste des URI des schémas de groupe SCIM 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 documenthttps://datatracker.ietf.org/doc/html/rfc7643#section-4.2 de schéma de base de l’Internet Engineering Task Force System for Cross-domain Identity Management. () urn :ietf :params :scim :schemas :extension :servicenow :2.0 :Group : ServiceNow schéma d’extension. 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 ne font pas partie du schéma de base. 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. Type de données : tableau de chaînes

Demande cURL mettant à jour les membres du groupe à l’aide de PUT

L’exemple suivant change le membre associé au groupe en Abraham Lincoln au lieu d’Abel Tutor et change le nom du groupe en É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 : SUPPRIMER /scim/Users/{user_id}

Supprime l’enregistrement utilisateur spécifié de la table Utilisateur [sys_user] 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/Users/{user_id}

URL par défaut : /api/now/scim/Users/{user_id}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 49. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par 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. Type de données : chaîne Table : Utilisateur [sys_user]

Tableau 50. Paramètres de requête

Nom	Description
Néant

Tableau 51. Paramètres du corps de la demande (JSON)

Nom	Description
Néant

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.

Tableau 52. En-têtes de demandes

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 53. En-têtes de réponses

En-tête	Description
Aucun

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.

Tableau 54. Codes d'état

Code d'état	Description
204	Aucun contenu. La demande a été correctement traitée.
404	Introuvable. L’élément demandé est introuvable.

Paramètres de corps de réponse (JSON)

Nom	Description
erreurs	Réponse qui décrit toutes les erreurs qui ont pu se produire pendant le traitement de la demande. Type de données : objet "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" }
Erreur.Détail	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
Erreur.É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

Renvoie un ou plusieurs enregistrements utilisateur de la table Utilisateur [sys_user] au sein d’une ServiceNow instance à l’aide du 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

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 55. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par 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 56. Paramètres de requête

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 indication excludedAttributes contraire.
compter	Nombre d’enregistrements à renvoyer. Une valeur négative est interprétée comme nulle. Type de données : nombre Maximum : 500 : une valeur supérieure à cette valeur entraîne une erreur de demande incorrecte. Valeur par défaut : 10
excludedAttributes	Liste séparée par des virgules des champs à 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’exclut aucun champ.
filtre	Expression de filtre à appliquer aux résultats de retour. Les filtres de champ sont exprimés sous la forme <field_name> <opérateur> <"valeur">. Consultez RFC7644 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 une 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, par exemple : [tapez eq « home » et streetAddress eq « xxxx"] [type eq « home » et locality eq « xxxx"] [type eq « home » et eq region « xxxx"] [taper eq « home » et postalCode eq « xxxx"] [tapez eq « home » et country eq « xxxx"] displayName emails : format fixe uniquement, tel que : [tapez eq « work » et value eq « emailValue"] externalId : seul l’opérateur EQ est pris en charge. id méta.créé méta.lastModified nom.familyName nom.prénom nom.deuxième prénom preferredLanguage phoneNumbers : format fixe uniquement, par exemple : [taper eq « work » et value eq « xxxx"] [taper eq « mobile » et value eq « xxxx"] [taper eq « home » et value eq « xxxx"] 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 Type de données : chaîne Par défaut : aucun filtrage
sortBy	Doit être spécifié avec le sortOrder paramètre. Champ selon lequel trier les résultats renvoyés. Le tri est insensible à la casse. Vous ne pouvez utiliser que les paramètres disponibles pour le filtrage du paramètre, à l’exception de , qui n’est sortByexternalIdpas autorisé. En outre, seuls les paramètres de remontée pas à pas suivants sont pris en charge : addressess - Seules les valeurs suivantes sont autorisées : addresses.streetAddress - Cartes à l’adresse postale du domicile. addresses.home.streetAddress addresses.locality - Cartes de la localité du domicile. addresses.home.locality addresses.region - Cartes de la région d’origine. addresses.home.region addresses.postalCode - Cartes jusqu’au code postal du domicile. addresses.home.postalCode addresses.country - Cartes du pays d’origine. addresses.home.country emails - Seules les valeurs suivantes sont autorisées : emails.value - Mappages au travail de type e-mail. emails.work.value phoneNumbers - Seules les valeurs suivantes sont autorisées : phoneNumbers.value - Les mappages au travail de type numéro de téléphone. phoneNumbers.home.value phoneNumbers.mobile.value phoneNumbers.work.value Pour les valeurs qui sont nulles : trié par ordre croissant : les valeurs nulles sont triées par ordre croissant. trié par ordre décroissant : les valeurs nulles sont triées vers le bas. Type de données : chaîne Valeur 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 de retour. Valeurs valides : ascendant descendant Type de données : chaîne Par défaut : croissant
startIndex	Index basé sur un dans la table Utilisateur [sys_user] où 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 définie sur une valeur inférieure à un est interprétée comme un. Non valide avec le paramètre chemin d’accès id . Type de données : chaîne Valeur par défaut : 1

Tableau 57. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Néant

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.

Tableau 58. En-têtes de demandes

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 59. En-têtes de réponses

En-tête	Description
Aucun

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.

Tableau 60. Codes d'état

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.

Paramètres de corps de réponse (JSON)

Nom	Description
itemsPerPage	Nombre d’enregistrements renvoyés dans les résultats renvoyés. Type de données : nombre
Ressources	Liste des enregistrements utilisateur. 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 : vrai : l’utilisateur est actif. faux : l’utilisateur est inactif. 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.code postal	Code postal. Type de données : chaîne
Ressources.adresses.région	État ou région. Type de données : chaîne
Adresses.Ressources.Adresse_rue	Adresse postale complète. Il peut s’agir du numéro de maison, du nom de 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. Prend actuellement uniquement en charge la maison. Type de données : chaîne
Ressources.nom_affichage	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.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
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
Ressources.Identificateurexterne	Identificateur unique affecté à l’utilisateur par l’entité qui le met en service. Type de données : chaîne
Ressources.groupes	Liste des groupes auxquels l’utilisateur appartient, soit par le biais d’une appartenance directe, soit par le biais de groupes imbriqués, soit par calcul dynamique. Type de données : tableau d’objets "groups": [ { "display": "String", "type": "String", "value": "String", "$ref": "String" } ]
Ressources.groupes.affichage	Nom du groupe associé. Type de données : chaîne
Ressources.groupes.type	Type d’association de groupe, par exemple directe ou indirecte. 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.méta.créées	Date et heure de création de l’enregistrement utilisateur. Type de données : chaîne
Ressources.méta.lastModified	Date et heure de la dernière modification de l’enregistrement utilisateur. Type de données : chaîne
Ressources.meta.emplacement	URI de l’utilisateur en cours de récupération. Type de données : chaîne
Ressources.méta.TypeRessources	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" }
Ressources.nom.familleNom	Nom de famille ou nom de famille de l’utilisateur. Type de données : chaîne
Ressources.nom.prénom	Prénom ou prénom de l’utilisateur. Type de données : chaîne
Ressources.nom.honorificPrefix	Nom ou titre honorifique de l’utilisateur, tel que Dr., Bishop ou Baron. Type de données : chaîne
Ressources.nom.intermédiaire	Deuxième prénom de l’utilisateur. Type de données : chaîne
Ressources.NumérosTéléphoniques	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érostéléphone.type	Type de numéro de téléphone. Valeurs possibles : accueil mobile travail Type de données : chaîne
Ressources.numérosté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
Ressources.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
Ressources.fuseau horaire	Fuseau horaire de l’utilisateur. Type de données : chaîne
Ressources.titre	Titre de l’utilisateur, tel que PDG ou Président. Type de données : chaîne
Ressources.nom_utilisateur	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 Temporaire Externe Inconnu 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 basé sur 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 renvoyés

Nom	Description
company	Détails sur la société associée de l’utilisateur. Type de données : objet "company": { "display": "String", "value": "String", "$ref": "String" }
company.display	Nom de la société. Type de données : chaîne
entreprise.valeur	Sys_id de l’enregistrement de la société. Type de données : chaîne
société.$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" }
costCenter.display	Nom du centre de coûts. Type de données : chaîne
costCenter.valeur	Sys_id de l’enregistrement du centre de coûts. Type de données : chaîne
costCenter.$ref	URI de référence du centre de coûts. Type de données : chaîne
department	Détails sur le département associé de l’utilisateur. Type de données : objet "department": { "display": "String", "value": "String", "$ref": "String" }
département.affichage	Nom du département. Type de données : chaîne
service.valeur	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
Numéro d’employé	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
valeur.emplacement	Sys_id de l’enregistrement de l’emplacement. Type de données : chaîne
location.$ref	URI de référence de 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
manager.value	Sys_id de l’enregistrement du gestionnaire. Type de données : chaîne
manager.$ref	URI de référence pour le gestionnaire. Type de données : chaîne

Demande cURL à l’aide d’attributs

L’exemple suivant montre comment obtenir deux utilisateurs en commençant au sixième enregistrement et en renvoyant uniquement 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 à l’aide d’un filtre

L’exemple suivant montre comment utiliser le filter paramètre pour renvoyer les deux premiers enregistrements utilisateur dont le 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":"[e-mail]",
                "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":"[e-mail]",
              "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}

Renvoie l’enregistrement utilisateur spécifié de la table Utilisateur [sys_user] au sein 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/Users/{user_id}

URL par défaut : /api/now/scim/Users/{user_id}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 61. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par 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 Table : Utilisateur [sys_user]

Tableau 62. Paramètres de requête

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 indication excludedAttributes contraire.
excludedAttributes	Liste séparée par des virgules des champs à 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’exclut aucun champ.

Tableau 63. Paramètres du corps de la demande (JSON)

Nom	Description
Néant

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.

Tableau 64. En-têtes de demandes

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 65. En-têtes de réponses

En-tête	Description
Aucun

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.

Tableau 66. Codes d'état

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.
404	Introuvable. L’élément demandé est introuvable.

Paramètres de corps de réponse (JSON)

Nom	Description
actif	Marqueur indiquant si l’utilisateur associé est actif au sein de l’instance ServiceNow . Valeurs possibles : vrai : l’utilisateur est actif. faux : l’utilisateur est inactif. 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
adresses.postalCode	Code postal. Type de données : chaîne
Adresses.Région	État ou région. Type de données : chaîne
adresses.adresses.rue	Adresse postale complète. Il peut s’agir du numéro de maison, du nom de 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. Prend actuellement uniquement en charge la maison. 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
emails.value	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 met en service. Type de données : chaîne
groupes	Liste des groupes auxquels l’utilisateur appartient, soit par le biais d’une appartenance directe, soit par le biais de groupes imbriqués, soit par calcul dynamique. Type de données : tableau d’objets "groups": [ { "display": "String", "type": "String", "value": "String", "$ref": "String" } ]
groupes.affichage	Nom du groupe associé. Type de données : chaîne
groupes.type	Type d’association de groupe, par exemple directe ou indirecte. Type de données : chaîne
groupes.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" }
méta.créé	Date et heure de création de l’enregistrement utilisateur. Type de données : chaîne
méta.lastModified	Date et heure de la dernière modification de l’enregistrement utilisateur. Type de données : chaîne
méta.emplacement	URI de l’utilisateur en cours de récupération. Type de données : chaîne
méta.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.familyName	Nom de famille ou nom de famille de l’utilisateur. Type de données : chaîne
nom.prénom	Prénom ou 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 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, tel que 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 Temporaire Externe Inconnu Type de données : chaîne

Paramètres d’extension renvoyés

Nom	Description
company	Détails sur la société associée de l’utilisateur. Type de données : objet "company": { "display": "String", "value": "String", "$ref": "String" }
company.display	Nom de la société. Type de données : chaîne
entreprise.valeur	Sys_id de l’enregistrement de la société. Type de données : chaîne
société.$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" }
costCenter.display	Nom du centre de coûts. Type de données : chaîne
costCenter.valeur	Sys_id de l’enregistrement du centre de coûts. Type de données : chaîne
costCenter.$ref	URI de référence du centre de coûts. Type de données : chaîne
department	Détails sur le département associé de l’utilisateur. Type de données : objet "department": { "display": "String", "value": "String", "$ref": "String" }
département.affichage	Nom du département. Type de données : chaîne
service.valeur	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
Numéro d’employé	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
valeur.emplacement	Sys_id de l’enregistrement de l’emplacement. Type de données : chaîne
location.$ref	URI de référence de 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
manager.value	Sys_id de l’enregistrement du gestionnaire. Type de données : chaîne
manager.$ref	URI de référence pour le gestionnaire. Type de données : chaîne

Demande cURL à l’aide de l’sys_id utilisateur

L’exemple suivant montre comment obtenir un enregistrement utilisateur spécifique en transmettant son 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":"[e-mail]",
        "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 : CORRECTIF /scim/Users/{user_id}

Vous permet d’ajouter, de remplacer et de supprimer des champs spécifiés dans un enregistrement utilisateur de la table Utilisateur [sys_user] 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/Users/{user_id}

URL par défaut : /api/now/scim/Users/{user_id}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 67. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par 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. Type de données : chaîne Table : Utilisateur [sys_user]

Tableau 68. Paramètres de requête

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 indication excludedAttributes contraire.
excludedAttributes	Liste séparée par des virgules des champs à 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’exclut aucun champ.

Tableau 69. Paramètres du corps de la demande (JSON)

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 : supprimer la valeur du champ spécifié. remplacer : remplace la valeur du champ spécifié. Type de données : chaîne
Operations.path	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 titre Champs imbriqués, tels 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"] { "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": "[e-mail]" } ] } Type de données : chaîne Par défaut : considère le champ comme une ressource utilisateur.
Opérations.valeur	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 champ est exprimé sous forme value de chaîne. "Operations": [ { "op": "add", "path": "title", "value": "xyz" } ] Vous pouvez également déclarer des valeurs de chaîne simples sans utiliser de value paramètres OR path , tels 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 qui définissent des champs supplémentaires à ajouter à l’enregistrement utilisateur et leurs valeurs associées, le champ est exprimé sous la value forme d’un tableau d’objets. "Operations": [ { "op": "add", "path": "phoneNumbers", "value": [ { "type": "work", "value": "9876543210" }, { "type": "home", "value": "9876783216" } ] } ] Lorsque vous spécifiez des nœuds d’attribut, l’entrée peut inclure l’imbrication comme suit : { "op": "replace", "value": { "name": { "familyName": "Jones", "givenName": "Jennifer" } } } Vous pouvez également spécifier l’imbrication dans le Operations.path: { "op": "replace", "path": "name.givenName", "value": "Jennifer" } Si le champ en cours de mise à jour n’est pas dans le schéma de base, vous devez placer la paire nom-valeur dans un objet qui spécifie l’URN du schéma associé. "value": { "<schema_urn>": { "<field_name>": "<new_value>" }, } Par exemple : "value": { "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User": { "employeeNumber": "13454" }, } Type de données : N’importe lequel
Opérations.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. Schéma SCIM URI de l’opération de correctif urn :ietf :params :scim :api :messages :2.0 :PatchOp. Type de données : chaîne

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.

Tableau 70. En-têtes de demandes

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 71. En-têtes de réponses

En-tête	Description
Aucun

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.

Tableau 72. Codes d'état

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é. Rechercher les valeurs non valides : Corps de demande mal formé. Le champ obligatoire n’est pas fourni ou vide. Une sys_id d’utilisateur ou de groupe non valide est fournie. 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.
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.

Paramètres de corps de réponse (JSON)

Nom	Description
actif	Marqueur indiquant si l’utilisateur associé est actif au sein de l’instance ServiceNow . Valeurs possibles : vrai : l’utilisateur est actif. faux : l’utilisateur est inactif. 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
adresses.postalCode	Code postal. Type de données : chaîne
Adresses.Région	État ou région. Type de données : chaîne
adresses.adresses.rue	Adresse postale complète. Il peut s’agir du numéro de maison, du nom de 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. Prend actuellement uniquement en charge la maison. 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
emails.value	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 qui décrit toutes les erreurs qui ont pu se produire pendant le traitement de la demande. Type de données : objet "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" }
Erreur.Détail	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
Erreur.É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 met en service. Type de données : chaîne
groupes	Liste des groupes auxquels l’utilisateur appartient, soit par le biais d’une appartenance directe, soit par le biais de groupes imbriqués, soit par calcul dynamique. Type de données : tableau d’objets "groups": [ { "display": "String", "type": "String", "value": "String", "$ref": "String" } ]
groupes.affichage	Nom du groupe associé. Type de données : chaîne
groupes.type	Type d’association de groupe, par exemple directe ou indirecte. Type de données : chaîne
groupes.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" }
méta.créé	Date et heure de création de l’enregistrement utilisateur. Type de données : chaîne
méta.lastModified	Date et heure de la dernière modification de l’enregistrement utilisateur. Type de données : chaîne
méta.emplacement	URI de l’utilisateur en cours de récupération. Type de données : chaîne
méta.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.familyName	Nom de famille ou nom de famille de l’utilisateur. Type de données : chaîne
nom.prénom	Prénom ou 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 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, tel que 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 Temporaire Externe Inconnu Type de données : chaîne

Paramètres d’extension renvoyés

Nom	Description
company	Détails sur la société associée de l’utilisateur. Type de données : objet "company": { "display": "String", "value": "String", "$ref": "String" }
company.display	Nom de la société. Type de données : chaîne
entreprise.valeur	Sys_id de l’enregistrement de la société. Type de données : chaîne
société.$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" }
costCenter.display	Nom du centre de coûts. Type de données : chaîne
costCenter.valeur	Sys_id de l’enregistrement du centre de coûts. Type de données : chaîne
costCenter.$ref	URI de référence du centre de coûts. Type de données : chaîne
department	Détails sur le département associé de l’utilisateur. Type de données : objet "department": { "display": "String", "value": "String", "$ref": "String" }
département.affichage	Nom du département. Type de données : chaîne
service.valeur	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
Numéro d’employé	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
valeur.emplacement	Sys_id de l’enregistrement de l’emplacement. Type de données : chaîne
location.$ref	URI de référence de 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
manager.value	Sys_id de l’enregistrement du gestionnaire. Type de données : chaîne
manager.$ref	URI de référence pour le gestionnaire. Type de données : chaîne

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":"[e-mail]",
      "type":"work"
    }
  ],
  "phoneNumbers":[
    {
      "value":"9876543210",
      "type":"work"
    }
  ],
  "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User":{
    "employeeNumber":"13454"
  }
}

SCIM : PUBLIER /scim/Utilisateurs

Crée un enregistrement 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, telles qu’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

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 73. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par 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 74. Paramètres de requête

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 indication excludedAttributes contraire.
excludedAttributes	Liste séparée par des virgules des champs à 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’exclut aucun champ.

Tableau 75. Paramètres de corps de demande (XML ou JSON)

Nom	Description
actif	Marqueur indiquant si l’utilisateur associé est actif au sein de l’instance ServiceNow . Valeurs possibles : vrai : l’utilisateur est actif. faux : l’utilisateur est inactif. 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
adresses.postalCode	Code postal. Type de données : chaîne
Adresses.Région	État ou région. Type de données : chaîne
adresses.adresses.rue	Adresse postale complète. Il peut s’agir du numéro de maison, du nom de 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. Prend actuellement uniquement en charge la maison. 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
emails.value	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 met en service. 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.familyName	Nom de famille ou nom de famille de l’utilisateur. Type de données : chaîne
nom.prénom	Prénom ou 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 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, tel que 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 Temporaire Externe Inconnu Type de données : chaîne
Schéma étendu
company	Détails sur la société associée de l’utilisateur. Type de données : objet "company": { "value": "String" }
entreprise.valeur	Obligatoire si la société est incluse dans la publication. Sys_id de l’enregistrement de 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": { "value": "String" }
costCenter.valeur	Requis si costCenter est inclus dans la publication. Sys_id de l’enregistrement du centre de coûts. Type de données : chaîne
department	Détails sur le département associé de l’utilisateur. Type de données : objet "department": { "value": "String" }
service.valeur	Requis si le département est inclus dans le poste. Sys_id de l’enregistrement du département. Type de données : chaîne
Numéro d’employé	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" }
valeur.emplacement	Obligatoire 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" }
manager.value	Requis si le responsable est inclus dans le poste. Sys_id de l’enregistrement du gestionnaire. Type de données : chaîne

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.

Tableau 76. En-têtes de demandes

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 77. En-têtes de réponses

En-tête	Description
Aucun

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.

Tableau 78. Codes d'état

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.

Paramètres du corps de la réponse (JSON ou XML)

Nom	Description
actif	Marqueur indiquant si l’utilisateur associé est actif au sein de l’instance ServiceNow . Valeurs possibles : vrai : l’utilisateur est actif. faux : l’utilisateur est inactif. 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
adresses.postalCode	Code postal. Type de données : chaîne
Adresses.Région	État ou région. Type de données : chaîne
adresses.adresses.rue	Adresse postale complète. Il peut s’agir du numéro de maison, du nom de 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. Prend actuellement uniquement en charge la maison. 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
emails.value	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 qui décrit toutes les erreurs qui ont pu se produire pendant le traitement de la demande. Type de données : objet "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" }
Erreur.Détail	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
Erreur.É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 met en service. Type de données : chaîne
groupes	Liste des groupes auxquels l’utilisateur appartient, soit par le biais d’une appartenance directe, soit par le biais de groupes imbriqués, soit par calcul dynamique. Type de données : tableau d’objets "groups": [ { "display": "String", "type": "String", "value": "String", "$ref": "String" } ]
groupes.affichage	Nom du groupe associé. Type de données : chaîne
groupes.type	Type d’association de groupe, par exemple directe ou indirecte. Type de données : chaîne
groupes.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" }
méta.créé	Date et heure de création de l’enregistrement utilisateur. Type de données : chaîne
méta.lastModified	Date et heure de la dernière modification de l’enregistrement utilisateur. Type de données : chaîne
méta.emplacement	URI de l’utilisateur en cours de récupération. Type de données : chaîne
méta.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.familyName	Nom de famille ou nom de famille de l’utilisateur. Type de données : chaîne
nom.prénom	Prénom ou 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 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, tel que 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 Temporaire Externe Inconnu 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": "[e-mail]",
        "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":"[e-mail]",
      "type":"work"
    }
  ],
  "phoneNumbers":[
    {
      "value":"9977553312",
      "type":"mobile"
    }
  ]
}

SCIM - PUT /scim/Users/{user_id}

Met à jour l’enregistrement de l’utilisateur spécifié dans la table Utilisateur [sys_user] 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/Users/{user_id}

URL par défaut : /api/now/scim/Users/{user_id}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 79. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par 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. Type de données : chaîne Table : Utilisateur [sys_user]

Tableau 80. Paramètres de requête

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 indication excludedAttributes contraire.
excludedAttributes	Liste séparée par des virgules des champs à 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’exclut aucun champ.

Tableau 81. Paramètres du corps de la demande (JSON)

Nom	Description
actif	Marqueur indiquant si l’utilisateur associé est actif au sein de l’instance ServiceNow . Valeurs possibles : vrai : l’utilisateur est actif. faux : l’utilisateur est inactif. 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
adresses.postalCode	Code postal. Type de données : chaîne
Adresses.Région	État ou région. Type de données : chaîne
adresses.adresses.rue	Adresse postale complète. Il peut s’agir du numéro de maison, du nom de 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. Prend actuellement uniquement en charge la maison. 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
emails.value	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 met en service. 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.familyName	Nom de famille ou nom de famille de l’utilisateur. Type de données : chaîne
nom.prénom	Prénom ou 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 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, tel que 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 Temporaire Externe Inconnu Type de données : chaîne
Schéma étendu
company	Détails sur la société associée de l’utilisateur. Type de données : objet "company": { "value": "String" }
entreprise.valeur	Obligatoire si la société est incluse dans la publication. Sys_id de l’enregistrement de 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": { "value": "String" }
costCenter.valeur	Requis si costCenter est inclus dans la publication. Sys_id de l’enregistrement du centre de coûts. Type de données : chaîne
department	Détails sur le département associé de l’utilisateur. Type de données : objet "department": { "value": "String" }
service.valeur	Requis si le département est inclus dans le poste. Sys_id de l’enregistrement du département. Type de données : chaîne
Numéro d’employé	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" }
valeur.emplacement	Obligatoire 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" }
manager.value	Requis si le responsable est inclus dans le poste. Sys_id de l’enregistrement du gestionnaire. Type de données : chaîne

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.

Tableau 82. En-têtes de demandes

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 83. En-têtes de réponses

En-tête	Description
Aucun

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.

Tableau 84. Codes d'état

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.

Paramètres de corps de réponse (JSON)

Nom	Description
actif	Marqueur indiquant si l’utilisateur associé est actif au sein de l’instance ServiceNow . Valeurs possibles : vrai : l’utilisateur est actif. faux : l’utilisateur est inactif. 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
adresses.postalCode	Code postal. Type de données : chaîne
Adresses.Région	État ou région. Type de données : chaîne
adresses.adresses.rue	Adresse postale complète. Il peut s’agir du numéro de maison, du nom de 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. Prend actuellement uniquement en charge la maison. 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
emails.value	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 qui décrit toutes les erreurs qui ont pu se produire pendant le traitement de la demande. Type de données : objet "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" }
Erreur.Détail	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
Erreur.É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 met en service. Type de données : chaîne
groupes	Liste des groupes auxquels l’utilisateur appartient, soit par le biais d’une appartenance directe, soit par le biais de groupes imbriqués, soit par calcul dynamique. Type de données : tableau d’objets "groups": [ { "display": "String", "type": "String", "value": "String", "$ref": "String" } ]
groupes.affichage	Nom du groupe associé. Type de données : chaîne
groupes.type	Type d’association de groupe, par exemple directe ou indirecte. Type de données : chaîne
groupes.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" }
méta.créé	Date et heure de création de l’enregistrement utilisateur. Type de données : chaîne
méta.lastModified	Date et heure de la dernière modification de l’enregistrement utilisateur. Type de données : chaîne
méta.emplacement	URI de l’utilisateur en cours de récupération. Type de données : chaîne
méta.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.familyName	Nom de famille ou nom de famille de l’utilisateur. Type de données : chaîne
nom.prénom	Prénom ou 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 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, tel que 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 Temporaire Externe Inconnu Type de données : chaîne

Paramètres d’extension renvoyés

Nom	Description
company	Détails sur la société associée de l’utilisateur. Type de données : objet "company": { "display": "String", "value": "String", "$ref": "String" }
company.display	Nom de la société. Type de données : chaîne
entreprise.valeur	Sys_id de l’enregistrement de la société. Type de données : chaîne
société.$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" }
costCenter.display	Nom du centre de coûts. Type de données : chaîne
costCenter.valeur	Sys_id de l’enregistrement du centre de coûts. Type de données : chaîne
costCenter.$ref	URI de référence du centre de coûts. Type de données : chaîne
department	Détails sur le département associé de l’utilisateur. Type de données : objet "department": { "display": "String", "value": "String", "$ref": "String" }
département.affichage	Nom du département. Type de données : chaîne
service.valeur	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
Numéro d’employé	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
valeur.emplacement	Sys_id de l’enregistrement de l’emplacement. Type de données : chaîne
location.$ref	URI de référence de 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
manager.value	Sys_id de l’enregistrement du gestionnaire. Type de données : chaîne
manager.$ref	URI de référence pour le gestionnaire. Type de données : chaîne

Demande cURL pour mettre à jour les informations 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": "[e-mail]",
      "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": "[e-mail]",
      "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

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 auquel 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

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 85. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par 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 86. Paramètres de requête

Nom	Description
Néant

Tableau 87. Paramètres du corps de la demande (JSON)

Nom	Description
Néant

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.

Tableau 88. En-têtes de demandes

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 89. En-têtes de réponses

En-tête	Description
Aucun

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.

Tableau 90. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.

Paramètres de corps de réponse (JSON)

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] } ]
Ressources.description	Brève description du type de ressource. Type de données : chaîne
Ressources.point de terminaison	Nom du point de terminaison adressable en HTTP par rapport à l’URL de base du fournisseur de service, par exemple « Utilisateurs ». Type de données : chaîne
Resources.id	Identificateur unique pour 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 qui décrivent plus en détail la ressource associée. Type de données : objet "metadata": { "location": "String", "resourceType": "String" }
Ressources.meta.emplacement	URI du type de ressource associé sur l’instance associée ServiceNow . Type de données : chaîne
Ressources.méta.TypeRessources	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
Resources.schema	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
Ressources.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
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.schémaExtensions.requises	Marqueur indiquant si l’extension de schéma est requise pour le type de ressource. Valeurs possibles : true : 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. Type de données : booléennes
Ressources.schémaExtensions.schéma	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 la 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 de ressources 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

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}

Récupère les informations sur le type de ressource SCIM (System for Cross-domain Identity Management) spécifié.

Il s’agit d’un point de terminaison public auquel 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}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 91. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par 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 : Entreprise CostCenter Département Groupe Emplacement Utilisateur Type de données : chaîne

Tableau 92. Paramètres de requête

Nom	Description
Néant

Tableau 93. Paramètres du corps de la demande (JSON)

Nom	Description
Néant

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.

Tableau 94. En-têtes de demandes

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 95. En-têtes de réponses

En-tête	Description
Aucun

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.

Tableau 96. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
404	Introuvable. L’élément demandé est introuvable.

Paramètres de corps de réponse (JSON)

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 « Entreprises ». Type de données : chaîne
id	Identificateur unique pour 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 qui décrivent plus en détail la ressource associée. Type de données : objet "metadata": { "location": "String", "resourceType": "String" }
méta.emplacement	URI du type de ressource associé sur l’instance associée ServiceNow . Type de données : chaîne
méta.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
Extensions de schéma	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.required	Marqueur indiquant si l’extension de schéma est requise pour le type de ressource. Valeurs possibles : true : 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. 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 la liste à la demande. Par exemple : « urn :ietf :params :scim :api :messages :2.0 :ListResponse » Type de données : chaîne

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/Schemas

Récupère des informations sur tous les schémas de ressources SCIM (System for 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 auquel 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

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 97. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par 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 98. Paramètres de requête

Nom	Description
Néant

Tableau 99. Paramètres du corps de la demande (JSON)

Nom	Description
Néant

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.

Tableau 100. En-têtes de demandes

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 101. En-têtes de réponses

En-tête	Description
Aucun

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.

Tableau 102. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.

Paramètres de corps de réponse (JSON)

Nom	Description
Résultats de retour de RFC7643 standard	La méthode renvoie des résultats conformes à la norme RFC7643. Pour plus d’informations, reportez-vous à la définition du schéma 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}

Récupère des informations sur les schémas de ressources SCIM (System for Cross-domain Identity Management) spécifiés 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 auquel 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}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 103. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par 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 la ressource à 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 104. Paramètres de requête

Nom	Description
Néant

Tableau 105. Paramètres du corps de la demande (JSON)

Nom	Description
Néant

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.

Tableau 106. En-têtes de demandes

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 107. En-têtes de réponses

En-tête	Description
Aucun

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.

Tableau 108. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
404	Introuvable. L’élément demandé est introuvable.

Paramètres de corps de réponse (JSON)

Nom	Description
Résultats de retour de RFC7643 standard	La méthode renvoie des résultats conformes à la norme RFC7643. Pour plus d’informations, reportez-vous à la définition du schéma dans la spécification RFC7643.

Demande cURL

L’exemple suivant montre comment obtenir le schéma SCIM de 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

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 auquel 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

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 109. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par 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 110. Paramètres de requête

Nom	Description
Néant

Tableau 111. Paramètres du corps de la demande (JSON)

Nom	Description
Néant

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.

Tableau 112. En-têtes de demandes

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 113. En-têtes de réponses

En-tête	Description
Aucun

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.

Tableau 114. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.

Paramètres de corps de réponse (JSON)

Nom	Description
Résultats de retour de RFC7643 standard	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 services 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/Sociétés

Renvoie un ou plusieurs enregistrements de société de la table Société [core_company] au sein d’une ServiceNow instance à l’aide du 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

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 115. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par 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 116. Paramètres de requête

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 indication excludedAttributes contraire.
compter	Nombre d’enregistrements à renvoyer. Une valeur négative est interprétée comme nulle. Type de données : nombre Maximum : 500 : une valeur supérieure à cette valeur entraîne une erreur de demande incorrecte. Valeur par défaut : 10
excludedAttributes	Liste séparée par des virgules des champs à 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’exclut aucun champ.
filtre	Expression de filtre à appliquer aux résultats de retour. Les filtres de champ sont exprimés sous la forme <field_name> <opérateur> <"valeur">. Consultez RFC7644 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 qui ont été modifiées pour la dernière fois avant le 3 octobre 2021, saisissez displayName SW « Acme » ET meta.lastModified lt « 2021-10-03T00:00:00Z ». Utilisez une remontée pas à pas pour spécifier les attributs imbriqués. Type de données : chaîne Par défaut : aucun filtrage
sortBy	Doit être spécifié avec le sortOrder paramètre. Champ selon lequel trier les résultats renvoyés. Le tri est insensible à la casse. Vous ne pouvez utiliser que les paramètres disponibles pour le filtrage du paramètre, sauf si cela externalId n’est sortBy pas autorisé. Pour les valeurs qui sont nulles : trié par ordre croissant : les valeurs nulles sont triées vers le haut. trié par ordre décroissant : les valeurs nulles sont triées vers le bas. 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 de retour. Valeurs valides : ascendant descendant Type de données : chaîne Par défaut : croissant
startIndex	Index basé sur un dans la table à laquelle commencer la récupération 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 définie sur une valeur inférieure à un est interprétée comme un. Type de données : chaîne Valeur par défaut : 1

Tableau 117. Paramètres du corps de la demande (JSON)

Nom	Description
Néant

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.

Tableau 118. En-têtes de demandes

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 119. En-têtes de réponses

En-tête	Description
Aucun

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.

Tableau 120. Codes d'état

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.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.

Paramètres de corps de réponse (JSON)

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 la 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.méta.créées	Date et heure de création de l’enregistrement de société associé. Type de données : chaîne
Ressources.méta.lastModified	Date et heure de la dernière modification de l’enregistrement de société associé. Type de données : chaîne
Ressources.meta.emplacement	URI de l’enregistrement de société associé. Type de données : chaîne
Ressources.méta.TypeRessources	Type de ressource SCIM ; toujours Société. Type de données : chaîne
Resources.name	Nom de la société Type de données : chaîne
Ressources.schémas	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 la 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

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}

Renvoie l’enregistrement de société spécifié de la table Société [core_company] au sein 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/Companies/{company_id}

URL par défaut : /api/now/scim/Groups/{company_id}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 121. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par 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 122. Paramètres de requête

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 indication excludedAttributes contraire.
excludedAttributes	Liste séparée par des virgules des champs à 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’exclut aucun champ.

Tableau 123. Paramètres du corps de la demande (JSON)

Nom	Description
Néant

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.

Tableau 124. En-têtes de demandes

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 125. En-têtes de réponses

En-tête	Description
Aucun

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.

Tableau 126. Codes d'état

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.
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.

Paramètres de corps de réponse (JSON)

Nom	Description
id	Sys_id de l’enregistrement de la 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" }
méta.créé	Date et heure de création de l’enregistrement de société associé. Type de données : chaîne
méta.lastModified	Date et heure de la dernière modification de l’enregistrement de société associé. Type de données : chaîne
méta.emplacement	URI de l’enregistrement de société associé. Type de données : chaîne
méta.resourceType	Type de ressource SCIM ; toujours Société. 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

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

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 à l’aide du 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

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 127. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par 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 128. Paramètres de requête

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 indication excludedAttributes contraire.
compter	Nombre d’enregistrements à renvoyer. Une valeur négative est interprétée comme nulle. Type de données : nombre Maximum : 500 : une valeur supérieure à cette valeur entraîne une erreur de demande incorrecte. Valeur par défaut : 10
excludedAttributes	Liste séparée par des virgules des champs à 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’exclut aucun champ.
filtre	Expression de filtre à appliquer aux résultats de retour. Les filtres de champ sont exprimés sous la forme <field_name> <opérateur> <"valeur">. Consultez RFC7644 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 « HR ». 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 « HR » et qui ont été modifiés pour la dernière fois avant le 3 octobre 2021, saisissez displayName SW « HR » et meta.lastModified lt « 2021-10-03T00:00:00Z ». Utilisez une remontée pas à pas pour spécifier les attributs imbriqués. Type de données : chaîne Par défaut : aucun filtrage
sortBy	Doit être spécifié avec le sortOrder paramètre. Champ selon lequel trier les résultats renvoyés. Le tri est insensible à la casse. Vous ne pouvez utiliser que les paramètres disponibles pour le filtrage du paramètre, sauf si cela externalId n’est sortBy pas autorisé. Pour les valeurs qui sont nulles : trié par ordre croissant : les valeurs nulles sont triées vers le haut. trié par ordre décroissant : les valeurs nulles sont triées vers le bas. 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 de retour. Valeurs valides : ascendant descendant Type de données : chaîne Par défaut : croissant
startIndex	Index basé sur un dans la table à laquelle commencer la récupération 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 définie sur une valeur inférieure à un est interprétée comme un. Type de données : chaîne Valeur par défaut : 1

Tableau 129. Paramètres du corps de la demande (SON)

Nom	Description
Néant

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.

Tableau 130. En-têtes de demandes

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 131. En-têtes de réponses

En-tête	Description
Aucun

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.

Tableau 132. Codes d'état

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.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.

Paramètres de corps de réponse (JSON)

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 du centre de coûts. Type de données : chaîne
Ressources.meta	Informations relatives à l’enregistrement du centre de coûts. Type de données : objet "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" }
Ressources.méta.créées	Date et heure de création de l’enregistrement du centre de coûts associé. Type de données : chaîne
Ressources.méta.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.emplacement	URI de l’enregistrement du centre de coûts associé. Type de données : chaîne
Ressources.méta.TypeRessources	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
Ressources.schémas	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 la 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

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}

Renvoie l’enregistrement du centre de coûts spécifié de la table Centre de coûts [cmn_cost_center] au sein d’une ServiceNow instance à l’aide du 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/{cost_center_id}

URL par défaut : /api/now/scim/CoostCenters/{cost_center_id}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 133. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par 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 du centre de coûts à renvoyer. Type de données : chaîne

Tableau 134. Paramètres de requête

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 indication excludedAttributes contraire.
excludedAttributes	Liste séparée par des virgules des champs à 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’exclut aucun champ.

Tableau 135. Paramètres du corps de la demande (JSON)

Nom	Description
Néant

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.

Tableau 136. En-têtes de demandes

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 137. En-têtes de réponses

En-tête	Description
Aucun

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.

Tableau 138. Codes d'état

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.
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.

Paramètres de corps de réponse (JSON)

Nom	Description
id	Sys_id de l’enregistrement du centre de coûts. Type de données : chaîne
métadonnées	Informations relatives à l’enregistrement du centre de coûts. Type de données : objet "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" }
méta.créé	Date et heure de création de l’enregistrement du centre de coûts associé. Type de données : chaîne
méta.lastModified	Date et heure de la dernière modification de l’enregistrement du centre de coûts associé. Type de données : chaîne
méta.emplacement	URI de l’enregistrement du centre de coûts associé. Type de données : chaîne
méta.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

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

Renvoie un ou plusieurs enregistrements de département de la table Département [cmn_department] au sein d’une ServiceNow instance à l’aide du 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

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 139. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par 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 140. Paramètres de requête

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 indication excludedAttributes contraire.
compter	Nombre d’enregistrements à renvoyer. Une valeur négative est interprétée comme nulle. Type de données : nombre Maximum : 500 : une valeur supérieure à cette valeur entraîne une erreur de demande incorrecte. Valeur par défaut : 10
excludedAttributes	Liste séparée par des virgules des champs à 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’exclut aucun champ.
filtre	Expression de filtre à appliquer aux résultats de retour. Les filtres de champ sont exprimés sous la forme <field_name> <opérateur> <"valeur">. Consultez RFC7644 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 qui ont été modifiés pour la dernière fois avant le 3 octobre 2021, saisissez displayName SW « Ingénieur » ET meta.lastModified lt « 2021-10-03T00:00:00Z ». Utilisez une remontée pas à pas pour spécifier les attributs imbriqués. Type de données : chaîne Par défaut : aucun filtrage
sortBy	Doit être spécifié avec le sortOrder paramètre. Champ selon lequel trier les résultats renvoyés. Le tri est insensible à la casse. Vous ne pouvez utiliser que les paramètres disponibles pour le filtrage du paramètre, sauf si cela externalId n’est sortBy pas autorisé. Pour les valeurs qui sont nulles : trié par ordre croissant : les valeurs nulles sont triées vers le haut. trié par ordre décroissant : les valeurs nulles sont triées vers le bas. 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 de retour. Valeurs valides : ascendant descendant Type de données : chaîne Par défaut : croissant
startIndex	Index basé sur un dans la table à laquelle commencer la récupération 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 définie sur une valeur inférieure à un est interprétée comme un. Type de données : chaîne Valeur par défaut : 1

Tableau 141. Paramètres du corps de la demande (JSON)

Nom	Description
Néant

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.

Tableau 142. En-têtes de demandes

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 143. En-têtes de réponses

En-tête	Description
Aucun

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.

Tableau 144. Codes d'état

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.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.

Paramètres de corps de réponse (JSON)

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.méta.créées	Date et heure de création de l’enregistrement de département associé. Type de données : chaîne
Ressources.méta.lastModified	Date et heure de la dernière modification de l’enregistrement du département associé. Type de données : chaîne
Ressources.meta.emplacement	URI de l’enregistrement du département associé. Type de données : chaîne
Ressources.méta.TypeRessources	Type de ressource SCIM ; toujours Département. Type de données : chaîne
Resources.name	Nom du département. Type de données : chaîne
Ressources.schémas
Schémas
startIndex	Index de 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

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}

Renvoie l’enregistrement du département spécifié de la table Département [cmn_department] au sein 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/Departments/{department_id}

URL par défaut : /api/now/scim/Departments/{department_id}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 145. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par 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 146. Paramètres de requête

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 indication excludedAttributes contraire.
excludedAttributes	Liste séparée par des virgules des champs à 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’exclut aucun champ.

Tableau 147. Paramètres du corps de la demande (JSON)

Nom	Description
Néant

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.

Tableau 148. En-têtes de demandes

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 149. En-têtes de réponses

En-tête	Description
Aucun

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.

Tableau 150. Codes d'état

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.
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.

Paramètres de corps de réponse (JSON)

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" }
méta.créé	Date et heure de création de l’enregistrement de département associé. Type de données : chaîne
méta.lastModified	Date et heure de la dernière modification de l’enregistrement du département associé. Type de données : chaîne
méta.emplacement	URI de l’enregistrement du département associé. Type de données : chaîne
méta.resourceType	Type de ressource SCIM ; toujours Département. Type de données : chaîne
nom	Nom du 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

Demande cURL

Cet exemple montre comment récupérer un enregistrement de département 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/Locations

Renvoie un ou plusieurs enregistrements d’emplacement de la table Emplacement [cmn_location] au sein d’une ServiceNow instance à l’aide du 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

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 151. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par 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 152. Paramètres de requête

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 indication excludedAttributes contraire.
compter	Nombre d’enregistrements à renvoyer. Une valeur négative est interprétée comme nulle. Type de données : nombre Maximum : 500 : une valeur supérieure à cette valeur entraîne une erreur de demande incorrecte. Valeur par défaut : 10
excludedAttributes	Liste séparée par des virgules des champs à 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’exclut aucun champ.
filtre	Expression de filtre à appliquer aux résultats de retour. Les filtres de champ sont exprimés sous la forme <field_name> <opérateur> <"valeur">. Consultez RFC7644 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 qui ont été modifiés pour la dernière fois avant le 3 octobre 2021, saisissez displayName SW « Ch » ET meta.lastModified lt « 2021-10-03T00:00:00Z ». Utilisez une remontée pas à pas pour spécifier les attributs imbriqués. Type de données : chaîne Par défaut : aucun filtrage
sortBy	Doit être spécifié avec le sortOrder paramètre. Champ selon lequel trier les résultats renvoyés. Le tri est insensible à la casse. Vous ne pouvez utiliser que les paramètres disponibles pour le filtrage du paramètre, sauf si cela externalId n’est sortBy pas autorisé. Pour les valeurs qui sont nulles : trié par ordre croissant : les valeurs nulles sont triées vers le haut. trié par ordre décroissant : les valeurs nulles sont triées vers le bas. 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 de retour. Valeurs valides : ascendant descendant Type de données : chaîne Par défaut : croissant
startIndex	Index basé sur un dans la table à laquelle commencer la récupération 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 définie sur une valeur inférieure à un est interprétée comme un. Type de données : chaîne Valeur par défaut : 1

Tableau 153. Paramètres du corps de la demande (JSON)

Nom	Description
Néant

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.

Tableau 154. En-têtes de demandes

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 155. En-têtes de réponses

En-tête	Description
Aucun

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.

Tableau 156. Codes d'état

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.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.

Paramètres de corps de réponse (JSON)

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 d’emplacement. Type de données : objet "meta": { "created": "String", "lastModified": "String", "location": "String", "resourceType": "String" }
Ressources.méta.créées	Date et heure de création de l’enregistrement d’emplacement associé. Type de données : chaîne
Ressources.méta.lastModified	Date et heure de la dernière modification de l’enregistrement d’emplacement associé. Type de données : chaîne
Ressources.meta.emplacement	URI de l’enregistrement de l’emplacement associé. Type de données : chaîne
Ressources.méta.TypeRessources	Type de ressource SCIM ; toujours Emplacement. Type de données : chaîne
Resources.name	Nom de l’emplacement. Type de données : chaîne
Ressources.schémas	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 la 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 Emplacement [cmn_location] où 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

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}

Renvoie l’enregistrement de l’emplacement spécifié de la table Emplacement [cmn_location] au sein 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/Locations/{location_id}

URL par défaut : /api/now/scim/Locations/{location_id}

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 157. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par 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 de l’emplacement à renvoyer. Type de données : chaîne

Tableau 158. Paramètres de requête

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 indication excludedAttributes contraire.
excludedAttributes	Liste séparée par des virgules des champs à 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’exclut aucun champ.

Tableau 159. Paramètres du corps de la demande (JSON)

Nom	Description
Néant

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.

Tableau 160. En-têtes de demandes

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 161. En-têtes de réponses

En-tête	Description
Aucun

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.

Tableau 162. Codes d'état

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.
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.

Paramètres de corps de réponse (JSON)

Nom	Description
id	Sys_id de l’enregistrement de l’emplacement. Type de données : chaîne
métadonnées	Informations relatives à l’enregistrement d’emplacement. Type de données : objet "meta": { "created": "String", "lastModified": "String", "location": "String", "resourceType": "String" }
méta.créé	Date et heure de création de l’enregistrement d’emplacement associé. Type de données : chaîne
méta.lastModified	Date et heure de la dernière modification de l’enregistrement d’emplacement associé. Type de données : chaîne
méta.emplacement	URI de l’enregistrement de l’emplacement associé. Type de données : chaîne
méta.resourceType	Type de ressource SCIM ; toujours 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

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"
}