System für die SCIM-API (Cross-Domain Identity Management)

Die System für domänenübergreifendes Identitätsmanagement (SCIM) Die API stellt Endpunkte zum Erstellen, Lesen, Aktualisieren und Löschen von Vorgängen für Anwender und Gruppen mithilfe des SCIM-Protokolls bereit.

Das SCIM-Protokoll ist ein HTTP-basiertes Protokoll auf Anwendungsebene, das auf HTTP [ RFC7230 ] Standard. Verwenden Sie diese API für die Bereitstellung und Verwaltung von Identitätsdaten, z. B. Anwender und Gruppen, im Web und in domänenübergreifenden Umgebungen, z. B. Enterprise-to-Cloud-Service Provider oder Inter-Cloud-Szenarien.

Um auf diese API zuzugreifen, müssen Sie SCIM v2 aktivieren – ServiceNow® Plugin „Domänenübergreifendes Identitätsmanagement“ (com.snc.integration.scim2).

Ressourcenzuordnung

Der SCIM-Service verfügt über sechs Ressourcen:

• Anwender (Core und Erweiterung)
• Gruppe (Core und Erweiterung)
• Unternehmen
• CostCenter
• Abteilung
• Standort

Die meisten Attribute in diesen SCIM-Ressourcen sind entsprechenden Feldern in einem vorhandenen zugeordnet ServiceNow Tabelle. Die folgenden Tabellen definieren diese Zuordnungen. Attribute, die nicht Feldern in vorhandenen entsprechen ServiceNow Tabellen sind zwei SCIM-spezifischen Tabellen zugeordnet. Weitere Informationen zu diesen Tabellen finden Sie unter SCIM-spezifische Tabellen .

Die SCIM-Anwenderressource verfügt sowohl über Core-Schemas (Schema: URN:ietf:params:scim:Schemas:Core:2,0:User) als auch über Erweiterungsschemata (URN:ietf:params:scim:Schemas:Extension:servicenow:2,0:User). Die meisten Anwender-Core- und Erweiterungsschema-Attribute sind der Anwendertabelle [sys_user] zugeordnet.

Tabelle : 1. Zuordnung von Anwenderressource zu Anwendertabelle [sys_user]

SCIM-Attributname	Anwenderfeldname
aktiv	aktiv
Adressen.Land	country
addresses.default.country	country
addresses.home.country	country
Adressen.Ort	city
addresses.default.locality	city
Adressen.Startseite.Ort	city
Adressen.Postcode	Postleitzahl
addresses.default.postalCode	Postleitzahl
Adressen.Startseite.Postcode	Postleitzahl
Adressen.Region	Status
addresses.default.region	Status
Adressen.Startseite.Region	Status
Adressen.streetAdresse	Straße
addresses.default.streetAddress	Straße
Adressen.Startseite.streetAdresse	Straße
displayName	name
E-Mails.Wert	E-Mail
emails.default.value	E-Mail
E-Mails.Arbeit.Wert	E-Mail
id	sys_id
Meta.erstellt	sys_created_on
Meta.lastModifiziert	sys_updated_on
Name.FAMILYNAME	last_name
Name.givenName	first_name
Name.HonorificPräfix	Einführung
Name.Mittelname	Zweiter_Name
Telefonnummern.Wert	Telefon
Telefonnummern.Startseite.Wert	home_phone
Telefonnummern.mobil.Wert	mobile_phone
Telefonnummern.Arbeit.Wert	Telefon
Bevorzugte Sprache	preferred_language
Feld	time_zone
Titel	Titel
userName	user_name

Tabelle : 2. Zuordnung von Anwenderressource zu SYS-SCIM-Anwendertabelle [sys_scim_user]

SCIM-Attributname	SYS-SCIM-Anwenderfeldname
externalId	external_id

Das erweiterte SCIM-Anwenderschema (URN:ietf:params:scim:Schemas:Extension:servicenow:2,0:User) ist der Anwendertabelle [sys_user] zugeordnet.

Tabelle : 3. Vom Anwender erweiterte Ressource zu Anwender [sys_user] Tabellenzuordnung

SCIM-Attributname	Anwenderfeldname
company.name	company.name
Unternehmen.Wert	Company.sys_ID
costCenter.name	cost_center.name
Kostenstelle.Wert	Cost_Center.sys_ID
department.name	department.name
Abteilung.Wert	Abteilung.sys_ID
Mitarbeiternummer	employee_number
Geschlecht	Geschlecht
location.name	location.name
Standort.Wert	Standort.sys_ID
manager.displayName	manager.name
manager.Wert	manager.sys_ID

Das SCIM-Gruppenressourcenschema (URN:ietf:params:scim:Schemas:Core:2,0:Group) ist der Tabelle „Gruppe“ [sys_user_Group] zugeordnet.

Tabelle : 4. Gruppenressource zu Gruppe [sys_user_Group]-Tabellenzuordnung

SCIM-Attributname	Gruppenfeldname
displayName	name
id	sys_id
Meta.erstellt	sys_created_on
Meta.lastModifiziert	sys_updated_on

Der Parameter „SCIM Group externalId“ ist der Tabelle „SYS-SCIM-Gruppe“ [sys_scim_Group] zugeordnet.

Tabelle : 5. Gruppenressource zu SYS-SCIM-Gruppe [sys_scim_Group]-Tabellenzuordnung

SCIM-Attributname	SYS-SCIM-Gruppenfeldname
externalId	external_id

Die SCIM-Gruppe ServiceNow Erweiterungsschema (URN:ietf:params:scim:Schemas:Extension:servicenow:2,0:Group) ist der Tabelle „Gruppe“ [sys_user_Group] zugeordnet.

Tabelle : 6. Gruppenressource zu Gruppe [sys_user_Group]-Tabellenzuordnung

SCIM-Attributname	Gruppenfeldname
Unternehmen.Wert	Company.sys_ID
company.name	company.name

Das SCIM-Unternehmensressourcenschema (URN:ietf:params:scim:Schemas:custom:servicenow:2,0:Company) ist der Tabelle „Unternehmen“ [Core_Company] zugeordnet.

Tabelle : 7. Zuordnung der Unternehmensressource zu der Tabelle „Unternehmen“ [Core_Company]

SCIM-Attributname	Feldname des Unternehmens
id	sys_id
Meta.erstellt	sys_created_on
Meta.lastModifiziert	sys_updated_on
name	name

Das SCIM-CostCenter-Ressourcenschema (URN:ietf:params:scim:Schemas:custom:servicenow:2,0:CostCenter) wird der Tabelle „Kostenstelle“ [cmn_Cost_Center] zugeordnet.

Tabelle : 8. Zuordnung der CostCenter-Ressource zu Kostenstelle [cmn_Cost_Center]-Tabelle

SCIM-Attributname	Feldname der Kostenstelle
id	sys_id
Meta.erstellt	sys_created_on
Meta.lastModifiziert	sys_updated_on
name	name

Das Ressourcenschema der SCIM-Abteilung (URN:ietf:params:scim:Schemas:custom:servicenow:2,0:Department) ist der Tabelle „Abteilung“ [cmn_Department] zugeordnet.

Tabelle : 9. Tabellenzuordnung von Abteilungsressource zu Abteilung [cmn_Department]

SCIM-Attributname	Abteilungsfeldname
id	sys_id
Meta.erstellt	sys_created_on
Meta.lastModifiziert	sys_updated_on
name	name

Das SCIM-Standortressourcenschema (URN:ietf:params:scim:Schemas:custom:servicenow:2,0:Location) ist der Tabelle „Standort“ [cmn_location] zugeordnet.

Tabelle : 10. Zuordnung der Standortressource zu Standort [cmn_location]

SCIM-Attributname	Feldname des Standorts
id	sys_id
Meta.erstellt	sys_created_on
Meta.lastModifiziert	sys_updated_on
name	name

SCIM-spezifische Tabellen

Zwei Tabellen, SYS-SCIM-Anwender [sys_scim_user] und SYS-SCIM-Gruppe [sys_scim_Group], enthalten die SCIM-Attribute, die nicht vorhandenen zugeordnet sind ServiceNow Tabellen. Im Folgenden wird der Inhalt dieser Tabellen definiert.

Tabelle : 11. Tabelle „SYS-SCIM-Anwender“ [sys_scim_user]

Feldname	Beschreibung
Erstellt	Datum und Uhrzeit der Erstellung des zugehörigen Datensatzes. Datentyp: Zeichenfolge Maximale Länge: 40
Erstellt von	Name der Entität, die den Datensatz erstellt hat. Datentyp: Zeichenfolge Maximale Länge: 40
Externe ID	Externe ID, die von der Entität verwendet wird, die diesen Anwenderdatensatz erstellt hat, um auf den Anwender in seinem System zu verweisen. Datentyp: Zeichenfolge Maximale Länge: 255
Sys-ID	Eindeutiger Bezeichner für den Datensatz in einem ServiceNow Instanz. Datentyp: Zeichenfolge Maximale Länge: 32
Aktualisiert	Datum und Uhrzeit der letzten Aktualisierung des zugehörigen Datensatzes. Datentyp: Zeichenfolge Maximale Länge: 40
Aktualisiert von	Name der Entität, die den zugehörigen Datensatz zuletzt aktualisiert hat. Datentyp: Zeichenfolge Maximale Länge: 40
FTP-Anwendernamen	Anzahl der Aktualisierungen des Datensatzes. Datentyp: Zahl (Ganzzahl) Maximale Länge: 40
Anwender	Verweis auf den Anwender, der diesem Datensatz zugeordnet ist Referenz: Anwendertabelle [sys_user] Maximale Länge: 32
Anwendertyp	Typ des Anwenderdatensatzes. Dieser Wert wird verwendet, um die Beziehung zwischen Organisation und Anwender zu identifizieren. Dies kann ein beliebiger Wert sein, typische Werte können jedoch Folgendes sein: Vertragsunternehmen Mitarbeiter Extern Praktikanten Temp Unbekannt Datentyp: Zeichenfolge Maximale Länge: 40

Tabelle : 12. Tabelle „SYS-SCIM-Gruppe“ [sys_scim_Group]

Feldname	Beschreibung
Erstellt	Datum und Uhrzeit der Erstellung des zugehörigen Datensatzes. Datentyp: Zeichenfolge Maximale Länge: 40
Erstellt von	Name der Entität, die den Datensatz erstellt hat. Datentyp: Zeichenfolge Maximale Länge: 40
Externe ID	Externe ID, die von der Entität verwendet wird, die diesen Gruppendatensatz erstellt hat, um auf die Gruppe in ihrem System zu verweisen. Datentyp: Zeichenfolge Maximale Länge: 255
Gruppe	Verweis auf die Gruppe, die diesem Datensatz zugeordnet ist. Referenz: Tabelle „Gruppe“ [sys_user_Group] Maximale Länge: 32
Sys-ID	Eindeutiger Bezeichner für den Datensatz in einem ServiceNow Instanz. Datentyp: Zeichenfolge Maximale Länge: 32
Aktualisiert	Datum und Uhrzeit der letzten Aktualisierung des zugehörigen Datensatzes. Datentyp: Zeichenfolge Maximale Länge: 40
Aktualisiert von	Name der Entität, die den zugehörigen Datensatz zuletzt aktualisiert hat. Datentyp: Zeichenfolge Maximale Länge: 40
FTP-Anwendernamen	Anzahl der Aktualisierungen des Datensatzes. Datentyp: Zahl (Ganzzahl) Maximale Länge: 40

Rollen und Zugriffssteuerungslisten

Die Rolle scim_admin ist erforderlich, um auf die SCIM-spezifischen Tabellen und die privaten SCIM-Endpunkte zuzugreifen, und ermöglicht den Zugriff auf die Tabellen „Anwender“ [sys_user] und „Gruppe“ [sys_user_Group].

Der SCIM-Service verfügt über vier ACLs für den Zugriff auf die Tabelle „SYS-SCIM-Anwender“ [sys_scim_user] und die Tabelle „SYS-scim-Gruppe“ [sys_scim_Group], die Erstellen, Löschen, Lesen und Schreiben ermöglichen. Diese ACLs sind nur der Rolle scim_admin zugeordnet.

SCIM: LÖSCHEN SIE /scim/Groups/{Group_ID}

Löscht den angegebenen Gruppendatensatz aus der Tabelle „Gruppe“ [sys_user_Group] von ServiceNow Instanz, die das SCIM-Protokoll (System for Domain Identity Management) verwendet.

URL-Format

Versionierte URL: /api/now/{api_Version}/scim/Groups/{Group_ID}

Standard-URL: /api/now/scim/Groups/{Group_ID}

Hinweis:

Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

Unterstützte Anforderungsparameter

Tabelle : 13. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
group_id	SYS_ID des zu löschenden Gruppendatensatzes. Datentyp: Zeichenfolge Tabelle: Gruppe [sys_user_group]

Tabelle : 14. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 15. Anforderungstext-Parameter (JSON)

Name	Beschreibung
Keine

Kopfzeilen

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 16. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/scim+json. Standard: application/json

Tabelle : 17. Antwortkopfzeilen

Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

Tabelle : 18. Statuscodes

Statuscode	Beschreibung
204	Kein Inhalt. Die Anforderung wurde erfolgreich verarbeitet.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
Fehler	Antwort, die alle Fehler beschreibt, die während der Verarbeitung der Anforderung aufgetreten sind. Datentyp: Objekt "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" }
errors.detail	Detaillierte Fehlermeldung, warum die Anforderung fehlgeschlagen ist. Datentyp: Zeichenfolge
Fehler.scimType	Stichwort für SCIM-Fehlerdetail. Datentyp: Zeichenfolge
Fehler.Schemas	URI der SCIM-Schemas, die zur Verarbeitung der Fehlerantwort verwendet werden. Datentyp: Array von Zeichenfolgen
Fehler.Status	HTTP-Statuscode für die Fehlerantwort. Datentyp: Zeichenfolge

Curl-Anforderung zum Löschen einer Gruppe

Dieses Beispiel zeigt, wie ein Gruppendatensatz aus der Tabelle „Gruppe“ [sys_user_Group] gelöscht wird.

curl "https://instance-servicenow.com/api/now/scim/Groups/a0a9e9fb1b7e3010593876a61a4bcbe0" \
--request DELETE \
--header "Accept:application/scim+json" \

SCIM: /scim/Groups ABRUFEN

Gibt einen oder mehrere Gruppendatensätze aus der Tabelle „Gruppe“ [sys_user_Group] in einem zurück ServiceNow Instanz, die das SCIM-Protokoll (System for Domain Identity Management) verwendet.

Hinweis:

Eine Abfrage, die keine Übereinstimmungen zurückgibt, gibt Erfolg (HTTP-Statuscode 200) mit zurück totalResultsAuf 0 festlegen.

URL-Format

Versionierte URL: /api/now/{api_Version}/scim/Groups

Standard-URL: /api/now/scim/Groups

Hinweis:

Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

Unterstützte Anforderungsparameter

Tabelle : 19. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 20. Abfrageparameter

Name	Beschreibung
Attribute	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit verwendet werden excludedAttributesParameter. Datentyp: Zeichenfolge Standard: Alle Felder zurückgeben, es sei denn excludedAttributesIst angegeben.
count	Anzahl der zurückzugebenden Datensätze. Ein negativer Wert wird als Null interpretiert. Datentyp: Zahl Maximum: 500 – Ein Wert größer als dieser führt zu einem Fehler bei einer ungültigen Anforderung. Standard: 10
Exklusive Attribute	Kommagetrennte Liste von Feldern, die aus den in der Antwort zurückgegebenen Datensätzen ausgeschlossen werden sollen. Alle anderen Felder werden zurückgegeben. Kann nicht mit verwendet werden attributesParameter. Datentyp: Zeichenfolge Standard: Schließen Sie keine Felder aus.
Filter	Filterausdruck, der auf die Rückgabeergebnisse angewendet werden soll. Feldfilter werden als ausgedrückt <field_name> <operator> <„value“> . Siehe RFC7644 Für eine Liste der gültigen Operatoren. Hinweis: Die NICHT Operator wird von dieser Methode nicht unterstützt. Um beispielsweise nach allen Gruppen zu filtern, deren Name mit „HR“ beginnt, geben Sie ein DisplayName SW „HR“ . Um mehr als einen Feldfilter anzugeben, verketten Sie die Filter mit UND Operand. Um beispielsweise nach allen Gruppen zu filtern, deren Name mit „HR“ beginnt und zuletzt vor dem 3. Oktober 2021 geändert wurden, geben Sie ein DisplayName SW „HR“ UND Meta.lastModified LT „2021-10-33T00:00:00Z“ . Verwenden Sie Dot-Walking, um geschachtelte Attribute anzugeben. Nur die folgenden SCIM-Gruppenfelder sind für die Verwendung in Filtern verfügbar: displayName ExternalID: Unterstützt nur EQ Operator. id Meta.erstellt Meta.lastModifiziert Datentyp: Zeichenfolge Standard: Keine Filterung
sortBy	Muss mit angegeben werden sortOrderParameter. Feld, nach dem die Rückgabeergebnisse sortiert werden sollen. Beim Sortieren wird die Groß-/Kleinschreibung nicht beachtet. Sie können nur die Parameter verwenden, die zum Filtern für verfügbar sind sortByParameter, außer dem externalIdIst nicht zulässig. Für Werte, die null sind: Aufsteigend sortiert: Nullwerte werden nach oben sortiert. Sortiert nach absteigend: Nullwerte werden nach unten sortiert. Datentyp: Zeichenfolge Standard: Keine Sortierung
sortOrder	Muss mit angegeben werden sortByParameter. Reihenfolge, in der sortByParameter wird auf die Rückgabeergebnisse angewendet. Gültige Werte: Aufsteigend Absteigend Datentyp: Zeichenfolge Standard: Aufsteigend
startIndex	Einbasierter Index in der Tabelle, bei der mit dem Abrufen von Datensätzen begonnen werden soll. Wenn Sie diesen Parameter beispielsweise auf 100 festlegen, und die countParameter für 20. Der Endpunkt gibt Datensätze 100 bis 119 zurück. Hinweis: Jeder Wert, der auf weniger als eins festgelegt ist, wird als einer interpretiert. Datentyp: Zeichenfolge Standard: 1

Tabelle : 21. Anforderungstext-Parameter (JSON)

Name	Beschreibung
Keine

Kopfzeilen

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 22. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/scim+json. Standard: application/json

Tabelle : 23. Antwortkopfzeilen

Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

Tabelle : 24. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. Stellen Sie sicher, dass beide attributesUnd excludedAttributesAbfrageparameter wurden in der Anforderung nicht übergeben. Stellen Sie sicher, dass countParameter ist nicht größer als 500. Stellen Sie sicher, dass alle vorhanden sind filterParameter sind gültig.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
ItemsPerPage	Anzahl der in den Rückgabeergebnissen zurückgegebenen Datensätze. Datentyp: Zahl
Ressourcen	Liste der Gruppendatensätze. Datentyp: Array von Objekten "Resources": [ { "company": {Object}, "displayName": "String", "externalId": "String", "id": "String", "meta": [Array] } ]
Resources.company	Details zum Unternehmen oder der Organisation der Gruppe. Datentyp: Objekt "company": { "display": "String", "$ref": "String", "value": "String" }
Resources.company.display	Name des Unternehmens. Datentyp: Zeichenfolge
Resources.company.$ref	Referenz-URI des Unternehmens. Format: <host>/Unternehmen/<company sys_id> , Z. B.: http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 . Datentyp: Zeichenfolge
Resources.company.value	SYS_ID des zugehörigen Unternehmens. Datentyp: Zeichenfolge
Ressourcen.displayName	Visuell lesbarer Name der Gruppe, z. B. HR-Team. Datentyp: Zeichenfolge
Ressourcen.externalId	Eindeutiger Bezeichner, der der Gruppe von der Entität zugewiesen wurde, die sie bereitstellt. Datentyp: Zeichenfolge
Ressourcen.ID	SYS_ID der Gruppe. Datentyp: Zeichenfolge
Ressourcen.Meta	Metadaten, die sich auf die Gruppe beziehen. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
Ressourcen.Meta.erstellt	Datum und Uhrzeit der Erstellung des Gruppendatensatzes. Datentyp: Zeichenfolge
Ressourcen.Meta.lastModifiziert	Datum und Uhrzeit der letzten Änderung des Gruppendatensatzes. Datentyp: Zeichenfolge
Ressourcen.Meta.Standort	URI der abgerufenen Gruppe. Datentyp: Zeichenfolge
Ressourcen.Meta.resourceType	Ressourcentyp der SCIM-Gruppen. Datentyp: Zeichenfolge
Ressourcen.Mitglieder	Liste der Anwender und Gruppen, die der Gruppe zugeordnet sind. Datentyp: Array von Objekten "members": [ { "display": "String", "value": "String", "$ref": "String" } ]
Ressourcen.Mitglieder.Anzeige	Name des zugehörigen Gruppenmitglieds. Datentyp: Zeichenfolge
Ressourcen.Mitglieder.Wert	SYS_ID des zugehörigen Anwender- oder Gruppendatensatzes. Datentyp: Zeichenfolge
Resources.members.$ref	URI des zugehörigen Gruppenmitglieds. Datentyp: Zeichenfolge
Ressourcen.Schemas	Liste der URIs der SCIM-Gruppenschemata, die zur Verarbeitung der Anforderung verwendet werden. Unterstützte Gruppenschemas: URN:ietf:params:scim:Schemas:Core:2,0:Gruppe: Kernschema, das im Internet Engineering Task Force-System für domänenübergreifendes Identitätsmanagement angegeben ist: Kernschema-Dokument ( https://datatracker.ietf.org/doc/html/rfc7643#section-4.2) URN:ietf:Parameters:scim:Schemas:Extension:servicenow:2,0:Gruppe – ServiceNow Erweiterungsschema. Dieses Schema enthält Attribute, die in der Tabelle „Gruppen“ [sys_user_Group] in einer Basis vorhanden sind ServiceNow System, sind jedoch nicht Teil des Kernschemas. URN:ietf:params:scim:Schemas:Extension:servicenow:custom:2,0:Group“: Anwenderdefiniertes Erweiterungsschema. Dieses Schema ist Teil des resourceType „Gruppe“ in der Tabelle „sys_scim_Schema_Extension“. Wenn das Schema nicht aktiv ist, wird der Schema-URN in der Antwort nicht zurückgegeben. Datentyp: Array von Zeichenfolgen
Schemas	Liste der URIs der SCIM-Listenantwortschemata, die zur Verarbeitung der Anforderung verwendet werden. Datentyp: Array
startIndex	Einbasierter Index in der Gruppentabelle [sys_user_Group], bei dem der Endpunkt mit dem Abrufen von Datensätzen begonnen hat. Datentyp: Zahl
totalResults	Gesamtanzahl der Datensätze, die der Anforderung entsprechen. Datentyp: Zahl

Curl-Anforderung für mehrere Gruppen

Dieses Beispiel zeigt, wie mehrere Gruppen (in diesem Fall vier) mit angefordert werden countParameter.

curl "https://instance-sevicenow.com/api/now/scim/Groups?count=4" \
--request GET \
--header "Accept:application/scim+json" \

Antwort:

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

Curl-Anforderung für mehrere Gruppen mit excludedAttributes

Dieses Beispiel zeigt, wie mehrere Gruppen (in diesem Fall vier) mit angefordert werden countParameter und ohne die Meta- und Mitgliederfelder.

curl "https://instance-sevicenow.com/api/now/scim/Groups?excludedAttributes=meta%2C%20members&count=4" \
--request GET \
--header "Accept:application/scim+json" \

Antwort:

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

Gibt den angegebenen Gruppendatensatz aus der Tabelle „Gruppe“ [sys_user_Group] in einem zurück ServiceNow Instanz, die das SCIM-Protokoll (System for Domain Identity Management) verwendet.

URL-Format

Versionierte URL: /api/now/{api_Version}/scim/Groups/{Group_ID}

Standard-URL: /api/now/scim/Groups/{Group_ID}

Hinweis:

Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

Unterstützte Anforderungsparameter

Tabelle : 25. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
group_id	SYS_ID des zurückzugebenden Gruppendatensatzes.

Tabelle : 26. Abfrageparameter

Name	Beschreibung
Attribute	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit verwendet werden excludedAttributesParameter. Datentyp: Zeichenfolge Standard: Alle Felder zurückgeben, es sei denn excludedAttributesIst angegeben.
Exklusive Attribute	Kommagetrennte Liste von Feldern, die aus den in der Antwort zurückgegebenen Datensätzen ausgeschlossen werden sollen. Alle anderen Felder werden zurückgegeben. Kann nicht mit verwendet werden attributesParameter. Datentyp: Zeichenfolge Standard: Schließen Sie keine Felder aus.

Tabelle : 27. Anforderungstext-Parameter (JSON)

Name	Beschreibung
Keine

Kopfzeilen

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 28. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/scim+json. Standard: application/json

Tabelle : 29. Antwortkopfzeilen

Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

Tabelle : 30. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. Stellen Sie sicher, dass beide attributesUnd excludedAttributesAbfrageparameter wurden in der Anforderung nicht übergeben. Stellen Sie sicher, dass countParameter ist nicht größer als 500. Stellen Sie sicher, dass alle vorhanden sind filterParameter sind gültig.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
Unternehmen	Details zum Unternehmen oder der Organisation der Gruppe. Datentyp: Objekt "company": { "display": "String", "$ref": "String", "value": "String" }
Unternehmen.Anzeige	Name des Unternehmens. Datentyp: Zeichenfolge
Unternehmen.$Ref	Referenz-URI des Unternehmens. Format: <host>/Unternehmen/<company sys_id> , Z. B.: http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 . Datentyp: Zeichenfolge
Unternehmen.Wert	SYS_ID des zugehörigen Unternehmens. Datentyp: Zeichenfolge
displayName	Visuell lesbarer Name der Gruppe, z. B. HR-Team. Datentyp: Zeichenfolge
externalId	Eindeutiger Bezeichner, der der Gruppe von der Entität zugewiesen wurde, die sie bereitstellt. Datentyp: Zeichenfolge
id	SYS_ID der Gruppe. Datentyp: Zeichenfolge
meta	Metadaten, die sich auf die Gruppe beziehen. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
Meta.erstellt	Datum und Uhrzeit der Erstellung des Gruppendatensatzes. Datentyp: Zeichenfolge
Meta.lastModifiziert	Datum und Uhrzeit der letzten Änderung des Gruppendatensatzes. Datentyp: Zeichenfolge
Meta.location	URI der abgerufenen Gruppe. Datentyp: Zeichenfolge
Meta.resourceType	Ressourcentyp der SCIM-Gruppen. Datentyp: Zeichenfolge
Mitglieder	Liste der Anwender und Gruppen, die der Gruppe zugeordnet sind. Datentyp: Array von Objekten "members": [ { "display": "String", "value": "String", "$ref": "String" } ]
Mitglieder.Anzeige	Name des zugehörigen Gruppenmitglieds. Datentyp: Zeichenfolge
Mitglieder.Wert	SYS_ID des zugehörigen Anwender- oder Gruppendatensatzes. Datentyp: Zeichenfolge
Mitglieder.$ref	URI des zugehörigen Gruppenmitglieds. Datentyp: Zeichenfolge
Schemas	Liste der URIs der SCIM-Gruppenschemata, die zur Verarbeitung der Anforderung verwendet werden. Unterstützte Gruppenschemas: URN:ietf:params:scim:Schemas:Core:2,0:Gruppe: Kernschema, das im Internet Engineering Task Force-System für domänenübergreifendes Identitätsmanagement angegeben ist: Kernschema-Dokument ( https://datatracker.ietf.org/doc/html/rfc7643#section-4.2) URN:ietf:Parameters:scim:Schemas:Extension:servicenow:2,0:Gruppe – ServiceNow Erweiterungsschema. Dieses Schema enthält Attribute, die in der Tabelle „Gruppen“ [sys_user_Group] in einer Basis vorhanden sind ServiceNow System, sind jedoch nicht Teil des Kernschemas. URN:ietf:params:scim:Schemas:Extension:servicenow:custom:2,0:Group“: Anwenderdefiniertes Erweiterungsschema. Dieses Schema ist Teil des resourceType „Gruppe“ in der Tabelle „sys_scim_Schema_Extension“. Wenn das Schema nicht aktiv ist, wird der Schema-URN in der Antwort nicht zurückgegeben. Datentyp: Array von Zeichenfolgen

Curl-Anforderung für bestimmte Gruppe

Dieses Beispiel zeigt, wie ein bestimmter Gruppendatensatz abgerufen wird.

curl "https://instance-servicenow.com/api/now/scim/Groups/e0140d671bbe3010593876a61a4bcb11" \
--request GET \
--header "Accept:application/scim+json" \

Antwort:

{"schemas":
  [
    "urn:ietf:params:scim:schemas:core:2.0:Group",
    "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group",
    "urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group"
  ],
  "id":"e0140d671bbe3010593876a61a4bcb11",
  "externalId":"8ae5dc9e-c7ad-4d3d-a152-35a6b6222b83",
  "meta":{
    "resourceType":"Group",
    "created":"2021-09-30T18:20:43Z",
    "lastModified":"2021-09-30T18:20:43Z",
    "location":"https://instance-servicenow.com/api/now/scim/Groups/e0140d671bbe3010593876a61a4bcb11"},
    "displayName":"HR Group",
    "members":[
      {
        "value":"62826bf03710200044e0bfc8bcbe5df1",
        "display":"Abel Tuter",
        "$ref": "http://instance-servicenow.com/api/now/scim/Users/62826bf03710200044e0bfc8bcbe5df1"
      }
    ], 
    "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group": {
      "company": {
        "value": "81fd65ecac1d55eb42a426568fc87a63",
        "name": "ACME Japan",
        "$ref": "http://111.111.1.11:8080/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63"
      }
    }
  }
}

SCIM: PATCH /scim/Groups/{Group_ID}

Ermöglicht Ihnen das Hinzufügen, Aktualisieren und Löschen angegebener Felder in einem Gruppendatensatz in der Tabelle „Gruppe“ [sys_user_Group] von ServiceNow Instanz, die das SCIM-Protokoll (System for Domain Identity Management) verwendet.

Weitere Informationen finden Sie unter Wird mit PATCH geändert Abschnitt von RFC 7644.

URL-Format

Versionierte URL: /api/now/{api_Version}/scim/Groups/{Group_ID}

Standard-URL: /api/now/scim/Groups/{Group_ID}

Unterstützte Anforderungsparameter

Tabelle : 31. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
group_id	SYS_ID des zu aktualisierenden Gruppendatensatzes. Datentyp: Zeichenfolge Tabelle: Gruppe [sys_user_group]

Tabelle : 32. Abfrageparameter

Name	Beschreibung
Attribute	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit verwendet werden excludedAttributesParameter. Datentyp: Zeichenfolge Standard: Alle Felder zurückgeben, es sei denn excludedAttributesIst angegeben.
Exklusive Attribute	Kommagetrennte Liste von Feldern, die aus den in der Antwort zurückgegebenen Datensätzen ausgeschlossen werden sollen. Alle anderen Felder werden zurückgegeben. Kann nicht mit verwendet werden attributesParameter. Datentyp: Zeichenfolge Standard: Schließen Sie keine Felder aus.

Tabelle : 33. Anforderungstext-Parameter (JSON)

Name	Beschreibung
Vorgänge	Erforderlich. Liste der Vorgangsobjekte, mit denen der angegebene Gruppendatensatz gepatcht werden soll. Datentyp: Array von Objekten "Operations": [ { "op": "String", "path": "String", "value": Any } ]
Vorgänge.OP	Erforderlich. Auszuführender Vorgang. Gültige Werte: Hinzufügen: Fügen Sie dem Gruppendatensatz das angegebene Feld und den angegebenen Wert hinzu. Entfernen: Entfernen Sie den Wert aus dem angegebenen Feld. Durch Datentyp „null“ ersetzt. Ersetzen: Ersetzen Sie den Wert des angegebenen Felds. Datentyp: Zeichenfolge
Vorgänge.Pfad	Erforderlich für Entfernen Vorgänge, optional für andere. Name/Pfad des zu ändernden Felds. Die pathParameter kann eines der folgenden Formate haben: Ein direktes Feld, z. B. DisplayName Im Falle eines komplexen Arrays ein Zeiger auf ein bestimmtes Element mit einem Filter, z. B.: E-Mails[Typ eq „Arbeit“] { "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" } } ] } Datentyp: Zeichenfolge Standard: Betrachtet das Feld als Ressource.
Vorgänge.Wert	Wert des in angegebenen Felds Operations.pathParameter. Das Format dieses Parameters hängt vom Datentyp des zugehörigen Felds ab. Wenn Sie beispielsweise eine einfache Zeichenfolge aktualisieren, z. B. den Titel, die valueFeld wird als Zeichenfolge ausgedrückt. "Operations": [ { "op": "add", "path": "displayName", "value": "HR Group" } ] Sie können auch einfache Zeichenfolgenwerte ohne deklarieren pathParameter, z. B.: "Operations": [ { "op": "add", "value": { "displayName": "HR Group" } } ] Im Folgenden wird gezeigt, wie Sie der Gruppe ein Mitglied hinzufügen: { "op": "add", "value": { "members": { "value": "62826bf03710200044e0bfc8bcbe5df1", } } } Wenn sich das zu aktualisierende Feld nicht im Basisschema befindet, müssen Sie das Name-Wert-Paar in ein Objekt einschließen, das den URN des zugeordneten Schemas angibt. "value": { "<schema_urn>": { "<field_name>": "<new_value>" }, } Zum Beispiel: "value": { "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group": { "groupNumber": "13454" }, } Datentyp: Beliebig
Vorgänge.Wert.Typ	Name des zu aktualisierenden Felds. Datentyp: Zeichenfolge
Vorgänge.Wert.Wert	Wert, mit dem das Feld aktualisiert werden soll. Datentyp: Zeichenfolge
Schemas	Erforderlich. SCIM-Schema-URI des Patch-Vorgangs: „URN:ietf:params:scim:api:messages:2,0:PatchOp“ Datentyp: Zeichenfolge

Header

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 34. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/scim+json. Standard: application/json
Content-Type	Datenformat des Anforderungstexts. Unterstützte Typen: application/jsonOder application/scim+json. Standard: application/json

Tabelle : 35. Antwortkopfzeilen

Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

Tabelle : 36. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
204	Erfolgreich. Kein Inhalt (gilt nur für SCIM-Gruppen-Patch-API) – Dieser 204-Status hängt vom Status der SCIM-UI-Eigenschaft ab, Aktivieren Sie die Gruppen-Patch-API-Antwort ohne Inhalt , Und unterliegt dem Attributparameter, der gemäß RFC übergeben wurde: https://www.rfc-editor.org/rfc/rfc7644#page-35 . Standardeigenschaftswert: Falsch Die Aktivieren Sie die Gruppen-Patch-API-Antwort ohne Inhalt Die Eigenschaft kann verwendet werden, um zusätzliche Leistungssteigerungen bei der Antwortausführung zu erzielen, wenn der Client keine Antwortressourcen verbrauchen möchte.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. Auf ungültige Werte prüfen: Fehlerhafter Anforderungstext. Pflichtfeld ist nicht angegeben oder leer. Ungültige Anwender- oder Gruppen-sys_ID angegeben. Überprüfen Sie, ob ein schreibgeschütztes oder unveränderliches Feld versucht, geändert zu werden. Stellen Sie sicher, dass beide attributesUnd excludedAttributesAbfrageparameter wurden in der Anforderung nicht übergeben, oder dass die Anforderung die maximale Anzahl von Mitgliedern nicht überschreitet.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
409	Gruppe ist bereits vorhanden. Die displayNameParameter muss eindeutig sein.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
Unternehmen	Details zum Unternehmen oder der Organisation der Gruppe. Datentyp: Objekt "company": { "display": "String", "$ref": "String", "value": "String" }
Unternehmen.Anzeige	Name des Unternehmens. Datentyp: Zeichenfolge
Unternehmen.$Ref	Referenz-URI des Unternehmens. Format: <host>/Unternehmen/<company sys_id> , Z. B.: http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 . Datentyp: Zeichenfolge
Unternehmen.Wert	SYS_ID des zugehörigen Unternehmens. Datentyp: Zeichenfolge
displayName	Visuell lesbarer Name der Gruppe, z. B. HR-Team. Datentyp: Zeichenfolge
externalId	Eindeutiger Bezeichner, der der Gruppe von der Entität zugewiesen wurde, die sie bereitstellt. Datentyp: Zeichenfolge
Fehler	Antwort, die alle Fehler beschreibt, die während der Verarbeitung der Anforderung aufgetreten sind. Datentyp: Objekt "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" }
errors.detail	Detaillierte Fehlermeldung, warum die Anforderung fehlgeschlagen ist. Datentyp: Zeichenfolge
Fehler.scimType	Stichwort für SCIM-Fehlerdetail. Datentyp: Zeichenfolge
Fehler.Schemas	URI der SCIM-Schemas, die zur Verarbeitung der Fehlerantwort verwendet werden. Datentyp: Array von Zeichenfolgen
Fehler.Status	HTTP-Statuscode für die Fehlerantwort. Datentyp: Zeichenfolge
displayName	Visuell lesbarer Name der Gruppe, z. B. HR-Team. Datentyp: Zeichenfolge
externalId	Eindeutiger Bezeichner, der der Gruppe von der Entität zugewiesen wurde, die sie bereitstellt. Datentyp: Zeichenfolge
id	SYS_ID der Gruppe. Datentyp: Zeichenfolge
Mitglieder	Liste der Anwender und Gruppen, die der Gruppe zugeordnet sind. Datentyp: Array von Objekten "members": [ { "display": "String", "value": "String", "$ref": "String" } ]
Mitglieder.Anzeige	Name des zugehörigen Gruppenmitglieds. Datentyp: Zeichenfolge
Mitglieder.Wert	SYS_ID des zugehörigen Anwender- oder Gruppendatensatzes. Datentyp: Zeichenfolge
Mitglieder.$ref	URI des zugehörigen Gruppenmitglieds. Datentyp: Zeichenfolge
meta	Metadaten, die sich auf die Gruppe beziehen. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
Meta.erstellt	Datum und Uhrzeit der Erstellung des Gruppendatensatzes. Datentyp: Zeichenfolge
Meta.lastModifiziert	Datum und Uhrzeit der letzten Änderung des Gruppendatensatzes. Datentyp: Zeichenfolge
Meta.location	URI der abgerufenen Gruppe. Datentyp: Zeichenfolge
Meta.resourceType	Ressourcentyp der SCIM-Gruppen. Datentyp: Zeichenfolge
Schemas	Liste der URIs der SCIM-Gruppenschemata, die zur Verarbeitung der Anforderung verwendet werden. Unterstützte Gruppenschemas: URN:ietf:params:scim:Schemas:Core:2,0:Gruppe: Kernschema, das im Internet Engineering Task Force-System für domänenübergreifendes Identitätsmanagement angegeben ist: Kernschema-Dokument ( https://datatracker.ietf.org/doc/html/rfc7643#section-4.2) URN:ietf:Parameters:scim:Schemas:Extension:servicenow:2,0:Gruppe – ServiceNow Erweiterungsschema. Dieses Schema enthält Attribute, die in der Tabelle „Gruppen“ [sys_user_Group] in einer Basis vorhanden sind ServiceNow System, sind jedoch nicht Teil des Kernschemas. URN:ietf:params:scim:Schemas:Extension:servicenow:custom:2,0:Group“: Anwenderdefiniertes Erweiterungsschema. Dieses Schema ist Teil des resourceType „Gruppe“ in der Tabelle „sys_scim_Schema_Extension“. Wenn das Schema nicht aktiv ist, wird der Schema-URN in der Antwort nicht zurückgegeben. Datentyp: Array von Zeichenfolgen

cURL-Anforderung

Dieses Beispiel zeigt, wie Sie einem Gruppendatensatz eine externe ID hinzufügen und die aktuelle Liste der zugehörigen Mitglieder (Anwender) ersetzen.

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

Antwort:

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group",
    "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group",
    'urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group'
  ],
  "id": "a92b84f96b073010638c83eece44af4e",
  "externalId": "278fdc2e-a6aa-4140-bd23-9ba4987a2938",
  "meta": {
    "resourceType": "Group",
    "created": "2021-10-07T13:58:22Z",
    "lastModified": "2021-10-07T15:48:44Z",
    "location":
      "https://instance-sevicenow/api/now/scim/Groups/a92b84f96b073010638c83eece44af4e"
  },
  "displayName": "HR Team",
  "members": [
    {
      "value": "62826bf03710200044e0bfc8bcbe5df1",
      "display": "Abel Tuter",
      "$ref":
        "https://instance-sevicenow/api/now/scim/Users/62826bf03710200044e0bfc8bcbe5df1"
    },
    {
      "value": "a8f98bb0eb32010045e1a5115206fe3a",
      "display": "Abraham Lincoln",
      "$ref":
        "https://instance-sevicenow/api/now/scim/Users/a8f98bb0eb32010045e1a5115206fe3a"
    }
  ],
  "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group": {
    "company": {
      "value": "81fd65ecac1d55eb42a426568fc87a63",
      "name": "ACME Japan",
      "$ref": "http://instance-sevicenow/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63"
    }
  }
}

SCIM: POST /scim/Groups

Erstellt einen Gruppendatensatz in der Tabelle „Gruppe“ [sys_user_Group] von ServiceNow Instanz, die das SCIM-Protokoll (System for Domain Identity Management) verwendet.

Sie können den Anzeigenamen der Gruppe definieren, eine externe ID, die zum Korrelieren dieser Gruppe mit einem externen System verwendet wird, und Mitglieder (Anwender/Gruppen) zur Gruppe hinzufügen.

Hinweis:

Die in der RFC7643-Spezifikation angegebenen Such- und Massenänderungen werden von diesem Endpunkt nicht unterstützt.

URL-Format

Versionierte URL: /api/now/{api_Version}/scim/Groups

Standard-URL: /api/now/scim/Groups

Hinweis:

Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

Unterstützte Anforderungsparameter

Tabelle : 37. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 38. Abfrageparameter

Name	Beschreibung
Attribute	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit verwendet werden excludedAttributesParameter. Datentyp: Zeichenfolge Standard: Alle Felder zurückgeben, es sei denn excludedAttributesIst angegeben.
Exklusive Attribute	Kommagetrennte Liste von Feldern, die aus den in der Antwort zurückgegebenen Datensätzen ausgeschlossen werden sollen. Alle anderen Felder werden zurückgegeben. Kann nicht mit verwendet werden attributesParameter. Datentyp: Zeichenfolge Standard: Schließen Sie keine Felder aus.

Tabelle : 39. Anforderungstext-Parameter (JSON)

Name	Beschreibung
Unternehmen	Details zum Unternehmen oder der Organisation der Gruppe. Datentyp: Objekt "company": { "display": "String", "$ref": "String", "value": "String" }
Unternehmen.Anzeige	Name des Unternehmens. Datentyp: Zeichenfolge
Unternehmen.$Ref	Referenz-URI des Unternehmens. Format: <host>/Unternehmen/<company sys_id> , Z. B.: http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 . Datentyp: Zeichenfolge
Unternehmen.Wert	SYS_ID des zugehörigen Unternehmens. Datentyp: Zeichenfolge
displayName	Erforderlich. Visuell lesbarer Name der Gruppe, z. B. HR-Team. Datentyp: Zeichenfolge
externalId	Eindeutiger Bezeichner, der der Gruppe von der Entität zugewiesen wurde, die sie bereitstellt. Datentyp: Zeichenfolge
Mitglieder	Liste der Anwender oder anderen Gruppen, die der Gruppe zugeordnet werden sollen. Datentyp: Array von Objekten "members:" [ { "value": "String" } ] Maximale Größe: 100 – Sie können diese maximale Größe ändern, indem Sie die Systemeigenschaft com.snc.interation.scim2.max.member.count aktualisieren.
Mitglieder.Wert	SYS_ID des zugehörigen Anwender- oder Gruppendatensatzes. Datentyp: Zeichenfolge
Schemas	Erforderlich. Liste der URIs der SCIM-Gruppenschemata, die zur Verarbeitung der Anforderung verwendet werden. Unterstützte Gruppenschemas: URN:ietf:params:scim:Schemas:Core:2,0:Gruppe: Kernschema, das im Internet Engineering Task Force-System für domänenübergreifendes Identitätsmanagement angegeben ist: Kernschema-Dokument ( https://datatracker.ietf.org/doc/html/rfc7643#section-4.2) URN:ietf:Parameters:scim:Schemas:Extension:servicenow:2,0:Gruppe – ServiceNow Erweiterungsschema. Dieses Schema enthält Attribute, die in der Tabelle „Gruppen“ [sys_user_Group] in einer Basis vorhanden sind ServiceNow System, sind jedoch nicht Teil des Kernschemas. URN:ietf:params:scim:Schemas:Extension:servicenow:custom:2,0:Group“: Anwenderdefiniertes Erweiterungsschema. Dieses Schema ist Teil des resourceType „Gruppe“ in der Tabelle „sys_scim_Schema_Extension“. Wenn das Schema nicht aktiv ist, wird der Schema-URN in der Antwort nicht zurückgegeben. Datentyp: Array von Zeichenfolgen

Header

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 40. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/scim+json. Standard: application/json
Content-Type	Datenformat des Anforderungstexts. Unterstützte Typen: application/jsonOder application/scim+json. Standard: application/json

Tabelle : 41. Antwortkopfzeilen

Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

Tabelle : 42. Statuscodes

Statuscode	Beschreibung
201	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. Auf ungültige Werte prüfen: Fehlerhafter Anforderungstext. Pflichtfeld ist nicht angegeben oder leer. Ungültige Anwender- oder Gruppen-sys_ID angegeben. Überprüfen Sie, ob ein schreibgeschütztes oder unveränderliches Feld versucht, geändert zu werden. Stellen Sie sicher, dass beide attributesUnd excludedAttributesAbfrageparameter wurden in der Anforderung nicht übergeben, oder dass die Anforderung die maximale Anzahl von Mitgliedern nicht überschreitet.
409	Gruppe ist bereits vorhanden. Die displayNameParameter muss eindeutig sein.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
Unternehmen	Details zum Unternehmen oder der Organisation der Gruppe. Datentyp: Objekt "company": { "display": "String", "$ref": "String", "value": "String" }
Unternehmen.Anzeige	Name des Unternehmens. Datentyp: Zeichenfolge
Unternehmen.$Ref	Referenz-URI des Unternehmens. Format: <host>/Unternehmen/<company sys_id> , Z. B.: http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 . Datentyp: Zeichenfolge
Unternehmen.Wert	SYS_ID des zugehörigen Unternehmens. Datentyp: Zeichenfolge
displayName	Visuell lesbarer Name der Gruppe, z. B. HR-Team. Datentyp: Zeichenfolge
externalId	Eindeutiger Bezeichner, der der Gruppe von der Entität zugewiesen wurde, die sie bereitstellt. Datentyp: Zeichenfolge
id	SYS_ID der Gruppe. Datentyp: Zeichenfolge
meta	Metadaten, die sich auf die Gruppe beziehen. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
Meta.erstellt	Datum und Uhrzeit der Erstellung des Gruppendatensatzes. Datentyp: Zeichenfolge
Meta.lastModifiziert	Datum und Uhrzeit der letzten Änderung des Gruppendatensatzes. Datentyp: Zeichenfolge
Meta.location	URI der abgerufenen Gruppe. Datentyp: Zeichenfolge
Meta.resourceType	Ressourcentyp der SCIM-Gruppen. Datentyp: Zeichenfolge
Mitglieder	Liste der Anwender und Gruppen, die der Gruppe zugeordnet sind. Datentyp: Array von Objekten "members": [ { "display": "String", "value": "String", "$ref": "String" } ]
Mitglieder.Anzeige	Name des zugehörigen Gruppenmitglieds. Datentyp: Zeichenfolge
Mitglieder.Wert	SYS_ID des zugehörigen Anwender- oder Gruppendatensatzes. Datentyp: Zeichenfolge
Mitglieder.$ref	URI des zugehörigen Gruppenmitglieds. Datentyp: Zeichenfolge
Schemas	Liste der URIs der SCIM-Gruppenschemata, die zur Verarbeitung der Anforderung verwendet werden. Unterstützte Gruppenschemas: URN:ietf:params:scim:Schemas:Core:2,0:Gruppe: Kernschema, das im Internet Engineering Task Force-System für domänenübergreifendes Identitätsmanagement angegeben ist: Kernschema-Dokument ( https://datatracker.ietf.org/doc/html/rfc7643#section-4.2) URN:ietf:Parameters:scim:Schemas:Extension:servicenow:2,0:Gruppe – ServiceNow Erweiterungsschema. Dieses Schema enthält Attribute, die in der Tabelle „Gruppen“ [sys_user_Group] in einer Basis vorhanden sind ServiceNow System, sind jedoch nicht Teil des Kernschemas. URN:ietf:params:scim:Schemas:Extension:servicenow:custom:2,0:Group“: Anwenderdefiniertes Erweiterungsschema. Dieses Schema ist Teil des resourceType „Gruppe“ in der Tabelle „sys_scim_Schema_Extension“. Wenn das Schema nicht aktiv ist, wird der Schema-URN in der Antwort nicht zurückgegeben. Datentyp: Array von Zeichenfolgen

Curl-Anforderung – VERÖFFENTLICHEN SIE eine neue Gruppe, und fügen Sie ein Mitglied hinzu

In diesem Beispiel wird gruppe51 erstellt und der Anwender Abel Tutor als Mitglied hinzugefügt.

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

Antwort:

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

Aktualisiert den angegebenen Gruppendatensatz in der Tabelle „Gruppe“ [sys_user_Group] von ServiceNow Instanz, die das SCIM-Protokoll (System for Domain Identity Management) verwendet.

Felder, die in der Anforderung ausgelassen werden, werden nicht aktualisiert. Sie können ein Feld explizit löschen, indem Sie seinen Wert für ein Feld mit einem einzelnen Wert auf null und für Felder vom Typ Array wie auf ein leeres Array festlegen members.

URL-Format

Versionierte URL: /api/now/{api_Version}/scim/Groups/{Group_ID}

Standard-URL: /api/now/scim/Groups/{Group_ID}

Hinweis:

Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

Unterstützte Anforderungsparameter

Tabelle : 43. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
group_id	SYS_ID des zu aktualisierenden Gruppendatensatzes. Datentyp: Zeichenfolge Tabelle: Gruppe [sys_user_group]

Tabelle : 44. Abfrageparameter

Name	Beschreibung
Attribute	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit verwendet werden excludedAttributesParameter. Datentyp: Zeichenfolge Standard: Alle Felder zurückgeben, es sei denn excludedAttributesIst angegeben.
Exklusive Attribute	Kommagetrennte Liste von Feldern, die aus den in der Antwort zurückgegebenen Datensätzen ausgeschlossen werden sollen. Alle anderen Felder werden zurückgegeben. Kann nicht mit verwendet werden attributesParameter. Datentyp: Zeichenfolge Standard: Schließen Sie keine Felder aus.

Tabelle : 45. Anforderungstext-Parameter (JSON)

Name	Beschreibung
Unternehmen	Details zum Unternehmen oder der Organisation der Gruppe. Datentyp: Objekt "company": { "display": "String", "$ref": "String", "value": "String" }
Unternehmen.Anzeige	Name des Unternehmens. Datentyp: Zeichenfolge
Unternehmen.$Ref	Referenz-URI des Unternehmens. Format: <host>/Unternehmen/<company sys_id> , Z. B.: http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 . Datentyp: Zeichenfolge
Unternehmen.Wert	SYS_ID des zugehörigen Unternehmens. Datentyp: Zeichenfolge
displayName	Visuell lesbarer Name der Gruppe, z. B. HR-Team. Datentyp: Zeichenfolge
externalId	Eindeutiger Bezeichner, der der Gruppe von der Entität zugewiesen wurde, die sie bereitstellt. Datentyp: Zeichenfolge
Mitglieder	Liste der Anwender, durch die die aktuelle Liste der Mitglieder ersetzt werden soll. Datentyp: Array von Objekten "members:" [ { "value": "String" } ] Maximale Größe: 100 – Sie können diese maximale Größe ändern, indem Sie die Systemeigenschaft com.snc.interation.scim2.max.member.count aktualisieren.
Mitglieder.Wert	SYS_ID des zugehörigen Anwender- oder Gruppendatensatzes. Datentyp: Zeichenfolge
Schemas	Erforderlich. Liste der URIs der SCIM-Gruppenschemata, die zur Verarbeitung der Anforderung verwendet werden. Unterstützte Gruppenschemas: URN:ietf:params:scim:Schemas:Core:2,0:Gruppe: Kernschema, das im Internet Engineering Task Force-System für domänenübergreifendes Identitätsmanagement angegeben ist: Kernschema-Dokument ( https://datatracker.ietf.org/doc/html/rfc7643#section-4.2) URN:ietf:Parameters:scim:Schemas:Extension:servicenow:2,0:Gruppe – ServiceNow Erweiterungsschema. Dieses Schema enthält Attribute, die in der Tabelle „Gruppen“ [sys_user_Group] in einer Basis vorhanden sind ServiceNow System, sind jedoch nicht Teil des Kernschemas. URN:ietf:params:scim:Schemas:Extension:servicenow:custom:2,0:Group“: Anwenderdefiniertes Erweiterungsschema. Dieses Schema ist Teil des resourceType „Gruppe“ in der Tabelle „sys_scim_Schema_Extension“. Wenn das Schema nicht aktiv ist, wird der Schema-URN in der Antwort nicht zurückgegeben. Datentyp: Array von Zeichenfolgen

Header

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 46. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/scim+json. Standard: application/json
Content-Type	Datenformat des Anforderungstexts. Unterstützte Typen: application/jsonOder application/scim+json. Standard: application/json

Tabelle : 47. Antwortkopfzeilen

Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

Tabelle : 48. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. Auf ungültige Werte prüfen: Fehlerhafter Anforderungstext. Pflichtfeld ist nicht angegeben oder leer. Ungültige Anwender- oder Gruppen-sys_ID angegeben. Überprüfen Sie, ob ein schreibgeschütztes oder unveränderliches Feld versucht, geändert zu werden. Stellen Sie sicher, dass beide attributesUnd excludedAttributesAbfrageparameter wurden in der Anforderung nicht übergeben, oder dass die Anforderung die maximale Anzahl von Mitgliedern nicht überschreitet.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
409	Gruppe ist bereits vorhanden. Die displayNameParameter muss eindeutig sein.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
Unternehmen	Details zum Unternehmen oder der Organisation der Gruppe. Datentyp: Objekt "company": { "display": "String", "$ref": "String", "value": "String" }
Unternehmen.Anzeige	Name des Unternehmens. Datentyp: Zeichenfolge
Unternehmen.$Ref	Referenz-URI des Unternehmens. Format: <host>/Unternehmen/<company sys_id> , Z. B.: http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 . Datentyp: Zeichenfolge
Unternehmen.Wert	SYS_ID des zugehörigen Unternehmens. Datentyp: Zeichenfolge
displayName	Visuell lesbarer Name der Gruppe, z. B. HR-Team. Datentyp: Zeichenfolge
Fehler	Antwort, die alle Fehler beschreibt, die während der Verarbeitung der Anforderung aufgetreten sind. Datentyp: Objekt "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" }
errors.detail	Detaillierte Fehlermeldung, warum die Anforderung fehlgeschlagen ist. Datentyp: Zeichenfolge
Fehler.scimType	Stichwort für SCIM-Fehlerdetail. Datentyp: Zeichenfolge
Fehler.Schemas	URI der SCIM-Schemas, die zur Verarbeitung der Fehlerantwort verwendet werden. Datentyp: Array von Zeichenfolgen
Fehler.Status	HTTP-Statuscode für die Fehlerantwort. Datentyp: Zeichenfolge
externalId	Eindeutiger Bezeichner, der der Gruppe von der Entität zugewiesen wurde, die sie bereitstellt. Datentyp: Zeichenfolge
id	SYS_ID der Gruppe. Datentyp: Zeichenfolge
Mitglieder	Liste der Anwender und Gruppen, die der Gruppe zugeordnet sind. Datentyp: Array von Objekten "members": [ { "display": "String", "value": "String", "$ref": "String" } ]
Mitglieder.Anzeige	Name des zugehörigen Gruppenmitglieds. Datentyp: Zeichenfolge
Mitglieder.Wert	SYS_ID des zugehörigen Anwender- oder Gruppendatensatzes. Datentyp: Zeichenfolge
Mitglieder.$ref	URI des zugehörigen Gruppenmitglieds. Datentyp: Zeichenfolge
meta	Metadaten, die sich auf die Gruppe beziehen. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
Meta.erstellt	Datum und Uhrzeit der Erstellung des Gruppendatensatzes. Datentyp: Zeichenfolge
Meta.lastModifiziert	Datum und Uhrzeit der letzten Änderung des Gruppendatensatzes. Datentyp: Zeichenfolge
Meta.location	URI der abgerufenen Gruppe. Datentyp: Zeichenfolge
Meta.resourceType	Ressourcentyp der SCIM-Gruppen. Datentyp: Zeichenfolge
Schemas	Liste der URIs der SCIM-Gruppenschemata, die zur Verarbeitung der Anforderung verwendet werden. Unterstützte Gruppenschemas: URN:ietf:params:scim:Schemas:Core:2,0:Gruppe: Kernschema, das im Internet Engineering Task Force-System für domänenübergreifendes Identitätsmanagement angegeben ist: Kernschema-Dokument ( https://datatracker.ietf.org/doc/html/rfc7643#section-4.2) URN:ietf:Parameters:scim:Schemas:Extension:servicenow:2,0:Gruppe – ServiceNow Erweiterungsschema. Dieses Schema enthält Attribute, die in der Tabelle „Gruppen“ [sys_user_Group] in einer Basis vorhanden sind ServiceNow System, sind jedoch nicht Teil des Kernschemas. URN:ietf:params:scim:Schemas:Extension:servicenow:custom:2,0:Group“: Anwenderdefiniertes Erweiterungsschema. Dieses Schema ist Teil des resourceType „Gruppe“ in der Tabelle „sys_scim_Schema_Extension“. Wenn das Schema nicht aktiv ist, wird der Schema-URN in der Antwort nicht zurückgegeben. Datentyp: Array von Zeichenfolgen

Curl-Anforderung zum Aktualisieren von Gruppenmitgliedern mithilfe von PUT

Im folgenden Beispiel wird das Mitglied, das der Gruppe zugeordnet ist, in Abraham Lincoln anstelle von Abel Tutor geändert und der Name der Gruppe in HR-Team geändert.

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

Antwort:

{"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: LÖSCHEN SIE /scim/Users/{user_ID}

Löscht den angegebenen Anwenderdatensatz aus der Anwendertabelle [sys_user] von ServiceNow Instanz, die das SCIM-Protokoll (System for Domain Identity Management) verwendet.

URL-Format

Versionierte URL: /api/now/{api_Version}/scim/Users/{user_ID}

Standard-URL: /api/now/scim/Users/{user_ID}

Hinweis:

Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

Unterstützte Anforderungsparameter

Tabelle : 49. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
user_id	SYS_ID des zu löschenden Anwenderdatensatzes. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user]

Tabelle : 50. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 51. Anforderungstext-Parameter (JSON)

Name	Beschreibung
Keine

Kopfzeilen

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 52. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/scim+json. Standard: application/json

Tabelle : 53. Antwortkopfzeilen

Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

Tabelle : 54. Statuscodes

Statuscode	Beschreibung
204	Kein Inhalt. Die Anforderung wurde erfolgreich verarbeitet.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
Fehler	Antwort, die alle Fehler beschreibt, die während der Verarbeitung der Anforderung aufgetreten sind. Datentyp: Objekt "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" }
errors.detail	Detaillierte Fehlermeldung, warum die Anforderung fehlgeschlagen ist. Datentyp: Zeichenfolge
Fehler.scimType	Stichwort für SCIM-Fehlerdetail. Datentyp: Zeichenfolge
Fehler.Schemas	URI der SCIM-Schemas, die zur Verarbeitung der Fehlerantwort verwendet werden. Datentyp: Array von Zeichenfolgen
Fehler.Status	HTTP-Statuscode für die Fehlerantwort. Datentyp: Zeichenfolge

cURL-Anforderung

Dieses Beispiel zeigt, wie ein Anwenderdatensatz aus der Tabelle „Anwender“ [sys_user] gelöscht wird.

curl "https://instance-servicenow.com/api/now/scim/Users/b7c5015f778330102e8cc5179e5a9992" \
--request DELETE \
--header "Accept:application/scim+json"  \

SCIM: /scim/Users ABRUFEN

Gibt einen oder mehrere Anwenderdatensätze aus der Anwendertabelle [sys_user] in zurück ServiceNow Instanz, die das SCIM-Protokoll (System for Domain Identity Management) verwendet.

Hinweis:

Eine Abfrage, die keine Übereinstimmungen zurückgibt, gibt Erfolg (HTTP-Statuscode 200) mit zurück totalResultsAuf 0 festlegen.

URL-Format

Versionierte URL: /api/now/{api_Version}/scim/Users

Standard-URL: /api/now/scim/Users

Hinweis:

Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

Unterstützte Anforderungsparameter

Tabelle : 55. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 56. Abfrageparameter

Name	Beschreibung
Attribute	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit verwendet werden excludedAttributesParameter. Datentyp: Zeichenfolge Standard: Alle Felder zurückgeben, es sei denn excludedAttributesIst angegeben.
count	Anzahl der zurückzugebenden Datensätze. Ein negativer Wert wird als Null interpretiert. Datentyp: Zahl Maximum: 500 – Ein Wert größer als dieser führt zu einem Fehler bei einer ungültigen Anforderung. Standard: 10
Exklusive Attribute	Kommagetrennte Liste von Feldern, die aus den in der Antwort zurückgegebenen Datensätzen ausgeschlossen werden sollen. Alle anderen Felder werden zurückgegeben. Kann nicht mit verwendet werden attributesParameter. Datentyp: Zeichenfolge Standard: Schließen Sie keine Felder aus.
Filter	Filterausdruck, der auf die Rückgabeergebnisse angewendet werden soll. Feldfilter werden als ausgedrückt <field_name> <operator> <„value“> . Siehe RFC7644 Für eine Liste der gültigen Operatoren. Hinweis: Die NICHT Operator wird nicht unterstützt. Um beispielsweise nach allen Anwendern zu filtern, deren Name mit „Jo“ beginnt, geben Sie ein Anwendername SW „Jo“ (Groß-/Kleinschreibung nicht beachten). Um mehr als einen Feldfilter anzugeben, verketten Sie die Filter mit UND Operand. Um beispielsweise nach allen Anwendern zu filtern, deren Name mit „Jo“ beginnt und deren Nachname „smi“ enthält, geben Sie ein Anwendername SW „john“ UND Name.FAMILYNAME CO „smi“ . Verwenden Sie Dot-Walking, um geschachtelte Attribute anzugeben. Nur die folgenden SCIM-Anwenderfelder sind für die Verwendung in Filtern verfügbar, und einige unterstützen, wie bereits erwähnt, nur das feste Format: aktiv Adressen: Nur festes Format, z. B.: [Geben Sie eq „Home“ und streetAddress eq „xxxx“ ein] [Geben Sie eq „Home“ und Ortseq „xxxx“ ein] [Geben Sie eq „Home“ und Regionseq „xxxx“ ein] [Geben Sie eq „Home“ und postalCode eq „xxxx“ ein] [Geben Sie eq „Home“ und Ländereq „xxxx“ ein] displayName E-Mails: Nur festes Format, z. B.: [Geben Sie eq „work“ und value eq „emailValue“ ein] ExternalID: Nur EQ Operator wird unterstützt. id Meta.erstellt Meta.lastModifiziert Name.FAMILYNAME Name.givenName Name.Mittelname Bevorzugte Sprache Telefonnummern: Nur festes Format, z. B.: [Geben Sie eq „Arbeit“ und Wert eq „xxxx“ ein] [Geben Sie eq „mobil“ und Wert eq „xxxx“ ein] [Geben Sie eq „Home“ und Wert eq „xxxx“ ein] Feld Titel userName URN:ietf:params:scim:Schemas:Extension:servicenow:2,0:Anwender:EmployeeNumber URN:ietf:params:scim:Schemas:Extension:servicenow:2,0:Anwender:Geschlecht URN:ietf:params:scim:Schemas:Extension:servicenow:2,0:Anwender:department.name URN:ietf:Parameter:scim:Schemas:Extension:servicenow:2,0:Anwender:Abteilung.Wert 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:Anwender:costCenter.name URN:ietf:params:scim:Schemas:Extension:servicenow:2,0:User:CostCenter.value URN:ietf:params:scim:Schemas:Extension:servicenow:2,0:Anwender:company.name URN:ietf:params:scim:Schemas:Extension:servicenow:2,0:User:Company.value URN:ietf:params:scim:Schemas:Extension:servicenow:2,0:Anwender:location.name URN:ietf:params:scim:Schemas:Extension:servicenow:2,0:User:location.value Datentyp: Zeichenfolge Standard: Keine Filterung
sortBy	Muss mit angegeben werden sortOrderParameter. Feld, nach dem die Rückgabeergebnisse sortiert werden sollen. Beim Sortieren wird die Groß-/Kleinschreibung nicht beachtet. Sie können nur die Parameter verwenden, die zum Filtern für verfügbar sind sortByParameter, mit Ausnahme von externalId, Was nicht zulässig ist. Außerdem werden nur die folgenden Dot-Walking-Parameter unterstützt: addressess – Nur die folgenden Werte sind zulässig: addresses.streetAddress - Zuordnungen zur Hausnummer. addresses.home.streetAddress addresses.locality – Zuordnungen zum Heimatort. addresses.home.locality addresses.region – Zuordnungen zur Heimatregion. addresses.home.region addresses.postalCode – Zuordnungen zur Postleitzahl (privat). addresses.home.postalCode addresses.country – Zuordnungen zum Heimatland. addresses.home.country emails – Nur die folgenden Werte sind zulässig: emails.value – Zuordnungen zum E-Mail-Typ „Arbeit“. emails.work.value phoneNumbers – Nur die folgenden Werte sind zulässig: phoneNumbers.value – Zuordnungen zum Telefonnummerntyp „Arbeit“. phoneNumbers.home.value phoneNumbers.mobile.value phoneNumbers.work.value Für Werte, die null sind: Aufsteigend sortiert: Null-Werte werden nach oben sortiert. Absteigend sortiert: Null-Werte werden nach unten sortiert. Datentyp: Zeichenfolge Standard: Keine Sortierung durchgeführt
sortOrder	Muss mit angegeben werden sortByParameter. Reihenfolge, in der sortByParameter wird auf die Rückgabeergebnisse angewendet. Gültige Werte: Aufsteigend Absteigend Datentyp: Zeichenfolge Standard: Aufsteigend
startIndex	Einbasierter Index in der Anwendertabelle [sys_user], bei dem mit dem Abrufen von Datensätzen begonnen werden soll. Wenn Sie diesen Parameter beispielsweise auf 100 festlegen, und die countParameter für 20. Der Endpunkt gibt Datensätze 100 bis 119 zurück. Hinweis: Jeder Wert, der auf weniger als eins festgelegt ist, wird als einer interpretiert. Nicht gültig mit idPfadparameter. Datentyp: Zeichenfolge Standard: 1

Tabelle : 57. Anforderungstextparameter (XML oder JSON)

Name	Beschreibung
Keine

Kopfzeilen

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 58. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/scim+json. Standard: application/json

Tabelle : 59. Antwortkopfzeilen

Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

Tabelle : 60. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. Stellen Sie sicher, dass beide attributesUnd excludedAttributesAbfrageparameter wurden in der Anforderung nicht übergeben. Stellen Sie sicher, dass countParameter ist nicht größer als 500. Stellen Sie sicher, dass alle vorhanden sind filterParameter sind gültig.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
ItemsPerPage	Anzahl der in den Rückgabeergebnissen zurückgegebenen Datensätze. Datentyp: Zahl
Ressourcen	Liste der Anwenderdatensätze. Datentyp: Array von Objekten "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" } ]
Ressourcen.aktiv	Kennzeichnung, die angibt, ob der zugeordnete Anwender in aktiv ist ServiceNow Instanz. Mögliche Werte: Wahr: Anwender ist aktiv. Falsch: Anwender ist inaktiv. Datentyp: Boolesch
Ressourcen.Adressen	Details zur aktuellen Mailadresse des Anwenders. Datentyp: Objekt "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" }
Resources.addresses.country	Ländername. Datentyp: Zeichenfolge
Ressourcen.Adressen.Ort	Name der Stadt oder des Orts. Datentyp: Zeichenfolge
Ressourcen.Adressen.Postcode	Postleitzahl. Datentyp: Zeichenfolge
Ressourcen.Adressen.Region	Bundesland oder Region. Datentyp: Zeichenfolge
Ressourcen.Adressen.streetAdresse	Vollständige Adresse mit Straße und Hausnummer. Dies kann Hausnummer, Straßenname, Postfach und mehrzeilige erweiterte Straßennutzungsinformationen umfassen. Datentyp: Zeichenfolge
Ressourcen.Adressen.Typ	Typ der Adresse. Derzeit nur unterstützt Startseite . Datentyp: Zeichenfolge
Ressourcen.displayName	Anwenderanzeigename. Dieser Wert wird durch Verkettung von automatisch generiert nameFelder. Datentyp: Zeichenfolge
Ressourcen.E-Mails	Liste der E-Mail-Accounts, die dem Anwender zugeordnet sind. Datentyp: Array von Objekten "emails:" [ { "type": "String", "value": "String" } ]
Ressourcen.E-Mails.Typ	Anwender-E-Mail-Typ. Unterstützt derzeit nur den Typ „Arbeit“. Datentyp: Zeichenfolge
Ressourcen.E-Mails.Wert	E-Mail-Adresse des Anwenders. Dies ist ein eindeutiger Schlüssel für den zugeordneten Anwender. Datentyp: Zeichenfolge
Ressourcen.externalId	Eindeutiger Bezeichner, der dem Anwender von der Entität zugewiesen wurde, die ihn bereitstellt. Datentyp: Zeichenfolge
Resources.groups	Liste der Gruppen, denen der Anwender angehört, entweder durch direkte Mitgliedschaft, geschachtelte Gruppen oder dynamisch berechnet. Datentyp: Array von Objekten "groups": [ { "display": "String", "type": "String", "value": "String", "$ref": "String" } ]
Resources.groups.display	Name der zugeordneten Gruppe. Datentyp: Zeichenfolge
Resources.groups.type	Typ der Gruppenzuordnung, z. B. direkt oder indirekt. Datentyp: Zeichenfolge
Resources.groups.value	SYS_ID eines zugeordneten Gruppendatensatzes. Datentyp: Zeichenfolge
Resources.groups.ref	URI der zugeordneten Gruppe. Datentyp: Zeichenfolge
Ressourcen.ID	SYS_ID des zugehörigen Anwenderdatensatzes. Datentyp: Zeichenfolge
Ressourcen.Meta	Metadaten, die sich auf den Anwender beziehen. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
Ressourcen.Meta.erstellt	Datum und Uhrzeit der Erstellung des Anwenderdatensatzes. Datentyp: Zeichenfolge
Ressourcen.Meta.lastModifiziert	Datum und Uhrzeit der letzten Änderung des Anwenderdatensatzes. Datentyp: Zeichenfolge
Ressourcen.Meta.Standort	URI des abgerufenen Anwenders. Datentyp: Zeichenfolge
Ressourcen.Meta.resourceType	Ressourcentyp von SCIM-Anwendern. Datentyp: Zeichenfolge
Resources.name	Informationen zum Anwendernamen. Datentyp: Objekt "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" }
Resources.name.familyName	Familie oder Nachname des Anwenders. Datentyp: Zeichenfolge
Resources.name.givenName	Vorname oder Vorname des Anwenders. Datentyp: Zeichenfolge
Resources.name.honorificPrefix	Ehrenvoller Name oder Titel des Anwenders, z. B. Dr., Bishop oder Baron. Datentyp: Zeichenfolge
Resources.name.middle	Zweiter Vorname des Anwenders. Datentyp: Zeichenfolge
Ressourcen.Telefonnummern	Liste der Telefonnummern, die dem Anwender zugeordnet sind. Datentyp: Array von Objekten "phoneNumbers": [ { "type": "String", "value": "String" } ]
Ressourcen.Telefonnummern.Typ	Typ der Telefonnummer. Mögliche Werte: Homepage Mobile Arbeit Datentyp: Zeichenfolge
Ressourcen.Telefonnummern.Wert	Telefonnummer des Anwenders. Datentyp: Zeichenfolge
Ressourcen.bevorzugte Sprache	Bevorzugte gesprochene und schriftliche Sprache des Anwenders. Datentyp: Zeichenfolge
Ressourcen.Schemas	Liste der URIs der SCIM-Anwenderschemata, die zur Verarbeitung der Anforderung verwendet werden. Datentyp: Array von Zeichenfolgen
Ressourcen.Zeitzone	Zeitzone des Anwenders. Datentyp: Zeichenfolge
Ressourcen.Titel	Titel des Anwenders, z. B. CEO oder Präsident. Datentyp: Zeichenfolge
Resources.userName	Eindeutiger Anwendername für den zugeordneten Anwender. Datentyp: Zeichenfolge
Resources.userType	Anwendertyp. Dieser Wert wird verwendet, um die Beziehung zwischen Organisation und Anwender zu identifizieren. Dies kann ein beliebiger Wert sein, typische Werte können jedoch Folgendes sein: Vertragsunternehmen Mitarbeiter Praktikanten Temp Extern Unbekannt Datentyp: Zeichenfolge
Schemas	Liste der URIs der SCIM ListResponse-Schemas, die zur Verarbeitung der Anforderung verwendet werden. Datentyp: Array von Zeichenfolgen
startIndex	Einbasierter Index in der Anwendertabelle [sys_user], in der die Datensätze zurückgegeben wurden. Datentyp: Zeichenfolge
totalResults	Gesamtanzahl der Datensätze, die der Anforderung entsprechen. Datentyp: Zahl

Erweiterungsparameter zurückgegeben

Name	Beschreibung
Unternehmen	Details zum zugehörigen Unternehmen des Anwenders. Datentyp: Objekt "company": { "display": "String", "value": "String", "$ref": "String" }
Unternehmen.Anzeige	Name des Unternehmens. Datentyp: Zeichenfolge
Unternehmen.Wert	SYS_ID des Unternehmensdatensatzes. Datentyp: Zeichenfolge
Unternehmen.$Ref	Referenz-URI für das Unternehmen. Datentyp: Zeichenfolge
Kostenstelle	Details zur zugeordneten Kostenstelle des Anwenders. Datentyp: Objekt "costCenter": { "display": "String", "value": "String", "$ref": "String" }
Kostenstelle.Anzeige	Name der Kostenstelle. Datentyp: Zeichenfolge
Kostenstelle.Wert	SYS_ID des Kostenstellendatensatzes. Datentyp: Zeichenfolge
CostCenter.$ref	Referenz-URI für die Kostenstelle. Datentyp: Zeichenfolge
department	Details zur zugehörigen Abteilung des Anwenders. Datentyp: Objekt "department": { "display": "String", "value": "String", "$ref": "String" }
Abteilung.Anzeige	Name der Abteilung. Datentyp: Zeichenfolge
Abteilung.Wert	SYS_ID des Abteilungsdatensatzes. Datentyp: Zeichenfolge
Abteilung.$ref	Referenz-URI für die Abteilung. Datentyp: Zeichenfolge
Mitarbeiternummer	Numerische oder alphanumerische Personalnummer. Datentyp: Zeichenfolge
Geschlecht	Geschlecht des Anwenders, z. B. männlich oder weiblich. Datentyp: Zeichenfolge
location	Details zum zugehörigen Standort des Anwenders. Datentyp: Objekt "location": { "display": "String", "value": "String", "$ref": "String" }
Standort.Anzeige	Name des Standorts. Datentyp: Zeichenfolge
Standort.Wert	SYS_ID des Standortdatensatzes. Datentyp: Zeichenfolge
Standort.$ref	Referenz-URI für den Standort. Datentyp: Zeichenfolge
Manager	Details zum zugeordneten Manager des Anwenders. Datentyp: Objekt "manager": { "display": "String", "value": "String", "$ref": "String" }
manager.Anzeige	Name des Managers. Datentyp: Zeichenfolge
manager.Wert	SYS_ID des Managerdatensatzes. Datentyp: Zeichenfolge
manager.$ref	Referenz-URI für den Manager. Datentyp: Zeichenfolge

Curl-Anforderung mit Attributen

Das folgende Beispiel zeigt, wie zwei Anwender ab dem sechsten Datensatz abgerufen werden und nur den Anzeigenamen zurückgeben.

curl "https://instance-servicenow.com/api/now/scim/Users?attributes=displayName&startIndex=6&count=2" \
--request GET \
--header "Accept:application/scim+json" \

Antwort:

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

Curl-Anforderung mithilfe eines Filters

Das folgende Beispiel zeigt die Verwendung von filterParameter zur Rückgabe der ersten beiden Anwenderdatensätze, deren angegebener Name mit „A“ beginnt.

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

Antwort:

{"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: /scim/Users/{user_ID} ABRUFEN

Gibt den angegebenen Anwenderdatensatz aus der Anwendertabelle [sys_user] in zurück ServiceNow Instanz, die das SCIM-Protokoll (System for Domain Identity Management) verwendet.

URL-Format

Versionierte URL: /api/now/{api_Version}/scim/Users/{user_ID}

Standard-URL: /api/now/scim/Users/{user_ID}

Hinweis:

Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

Unterstützte Anforderungsparameter

Tabelle : 61. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
user_id	SYS_ID des zurückzugebenden Anwenderdatensatzes. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user]

Tabelle : 62. Abfrageparameter

Name	Beschreibung
Attribute	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit verwendet werden excludedAttributesParameter. Datentyp: Zeichenfolge Standard: Alle Felder zurückgeben, es sei denn excludedAttributesIst angegeben.
Exklusive Attribute	Kommagetrennte Liste von Feldern, die aus den in der Antwort zurückgegebenen Datensätzen ausgeschlossen werden sollen. Alle anderen Felder werden zurückgegeben. Kann nicht mit verwendet werden attributesParameter. Datentyp: Zeichenfolge Standard: Schließen Sie keine Felder aus.

Tabelle : 63. Anforderungstext-Parameter (JSON)

Name	Beschreibung
Keine

Kopfzeilen

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 64. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/scim+json. Standard: application/json

Tabelle : 65. Antwortkopfzeilen

Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

Tabelle : 66. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. Stellen Sie sicher, dass beide attributesUnd excludedAttributesAbfrageparameter wurden in der Anforderung nicht übergeben. Stellen Sie sicher, dass countParameter ist nicht größer als 500. Stellen Sie sicher, dass alle vorhanden sind filterParameter sind gültig.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
aktiv	Kennzeichnung, die angibt, ob der zugeordnete Anwender in aktiv ist ServiceNow Instanz. Mögliche Werte: Wahr: Anwender ist aktiv. Falsch: Anwender ist inaktiv. Datentyp: Boolesch
addresses	Details zur aktuellen Mailadresse des Anwenders. Datentyp: Objekt "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" }
Adressen.Land	Ländername. Datentyp: Zeichenfolge
Adressen.Ort	Name der Stadt oder des Orts. Datentyp: Zeichenfolge
Adressen.Postcode	Postleitzahl. Datentyp: Zeichenfolge
Adressen.Region	Bundesland oder Region. Datentyp: Zeichenfolge
Adressen.streetAdresse	Vollständige Adresse mit Straße und Hausnummer. Dies kann Hausnummer, Straßenname, Postfach und mehrzeilige erweiterte Straßennutzungsinformationen umfassen. Datentyp: Zeichenfolge
Adressen.Typ	Typ der Adresse. Derzeit nur unterstützt Startseite . Datentyp: Zeichenfolge
displayName	Anwenderanzeigename. Dieser Wert wird durch Verkettung von automatisch generiert nameFelder. Datentyp: Zeichenfolge
E-Mails	Liste der E-Mail-Accounts, die dem Anwender zugeordnet sind. Datentyp: Array von Objekten "emails:" [ { "type": "String", "value": "String" } ]
E-Mails.Typ	Anwender-E-Mail-Typ. Unterstützt derzeit nur den Typ „Arbeit“. Datentyp: Zeichenfolge
E-Mails.Wert	E-Mail-Adresse des Anwenders. Dies ist ein eindeutiger Schlüssel für den zugeordneten Anwender. Datentyp: Zeichenfolge
externalId	Eindeutiger Bezeichner, der dem Anwender von der Entität zugewiesen wurde, die ihn bereitstellt. Datentyp: Zeichenfolge
groups	Liste der Gruppen, denen der Anwender angehört, entweder durch direkte Mitgliedschaft, geschachtelte Gruppen oder dynamisch berechnet. Datentyp: Array von Objekten "groups": [ { "display": "String", "type": "String", "value": "String", "$ref": "String" } ]
Gruppen.Anzeige	Name der zugeordneten Gruppe. Datentyp: Zeichenfolge
Gruppen.Typ	Typ der Gruppenzuordnung, z. B. direkt oder indirekt. Datentyp: Zeichenfolge
Gruppen.Wert	SYS_ID eines zugeordneten Gruppendatensatzes. Datentyp: Zeichenfolge
Gruppen.$ref	URI der zugeordneten Gruppe. Datentyp: Zeichenfolge
id	SYS_ID des zugehörigen Anwenderdatensatzes. Datentyp: Zeichenfolge
meta	Metadaten, die sich auf den Anwender beziehen. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
Meta.erstellt	Datum und Uhrzeit der Erstellung des Anwenderdatensatzes. Datentyp: Zeichenfolge
Meta.lastModifiziert	Datum und Uhrzeit der letzten Änderung des Anwenderdatensatzes. Datentyp: Zeichenfolge
Meta.location	URI des abgerufenen Anwenders. Datentyp: Zeichenfolge
Meta.resourceType	Ressourcentyp von SCIM-Anwendern. Datentyp: Zeichenfolge
name	Informationen zum Anwendernamen. Datentyp: Objekt "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" }
Name.FAMILYNAME	Familie oder Nachname des Anwenders. Datentyp: Zeichenfolge
Name.givenName	Vorname oder Vorname des Anwenders. Datentyp: Zeichenfolge
Name.HonorificPräfix	Ehrenvoller Name oder Titel des Anwenders, z. B. Dr., Bishop oder Baron. Datentyp: Zeichenfolge
Name.Mitte	Zweiter Vorname des Anwenders. Datentyp: Zeichenfolge
phoneNumbers	Liste der Telefonnummern, die dem Anwender zugeordnet sind. Datentyp: Array von Objekten "phoneNumbers": [ { "type": "String", "value": "String" } ]
Telefonnummern.Typ	Typ der Telefonnummer. Mögliche Werte: Homepage Mobile Arbeit Datentyp: Zeichenfolge
Telefonnummern.Wert	Telefonnummer des Anwenders. Datentyp: Zeichenfolge
Bevorzugte Sprache	Bevorzugte gesprochene und schriftliche Sprache des Anwenders. Datentyp: Zeichenfolge
Schemas	Liste der URIs der SCIM-Anwenderschemata, die zur Verarbeitung der Anforderung verwendet werden. Datentyp: Array von Zeichenfolgen
Feld	Zeitzone des Anwenders. Datentyp: Zeichenfolge
Titel	Titel des Anwenders, z. B. CEO oder Präsident. Datentyp: Zeichenfolge
userName	Eindeutiger Anwendername für den zugeordneten Anwender. Datentyp: Zeichenfolge
Anwendertyp	Anwendertyp. Dieser Wert wird verwendet, um die Beziehung zwischen Organisation und Anwender zu identifizieren. Dies kann ein beliebiger Wert sein, typische Werte können jedoch Folgendes sein: Vertragsunternehmen Mitarbeiter Praktikanten Temp Extern Unbekannt Datentyp: Zeichenfolge

Erweiterungsparameter zurückgegeben

Name	Beschreibung
Unternehmen	Details zum zugehörigen Unternehmen des Anwenders. Datentyp: Objekt "company": { "display": "String", "value": "String", "$ref": "String" }
Unternehmen.Anzeige	Name des Unternehmens. Datentyp: Zeichenfolge
Unternehmen.Wert	SYS_ID des Unternehmensdatensatzes. Datentyp: Zeichenfolge
Unternehmen.$Ref	Referenz-URI für das Unternehmen. Datentyp: Zeichenfolge
Kostenstelle	Details zur zugeordneten Kostenstelle des Anwenders. Datentyp: Objekt "costCenter": { "display": "String", "value": "String", "$ref": "String" }
Kostenstelle.Anzeige	Name der Kostenstelle. Datentyp: Zeichenfolge
Kostenstelle.Wert	SYS_ID des Kostenstellendatensatzes. Datentyp: Zeichenfolge
CostCenter.$ref	Referenz-URI für die Kostenstelle. Datentyp: Zeichenfolge
department	Details zur zugehörigen Abteilung des Anwenders. Datentyp: Objekt "department": { "display": "String", "value": "String", "$ref": "String" }
Abteilung.Anzeige	Name der Abteilung. Datentyp: Zeichenfolge
Abteilung.Wert	SYS_ID des Abteilungsdatensatzes. Datentyp: Zeichenfolge
Abteilung.$ref	Referenz-URI für die Abteilung. Datentyp: Zeichenfolge
Mitarbeiternummer	Numerische oder alphanumerische Personalnummer. Datentyp: Zeichenfolge
Geschlecht	Geschlecht des Anwenders, z. B. männlich oder weiblich. Datentyp: Zeichenfolge
location	Details zum zugehörigen Standort des Anwenders. Datentyp: Objekt "location": { "display": "String", "value": "String", "$ref": "String" }
Standort.Anzeige	Name des Standorts. Datentyp: Zeichenfolge
Standort.Wert	SYS_ID des Standortdatensatzes. Datentyp: Zeichenfolge
Standort.$ref	Referenz-URI für den Standort. Datentyp: Zeichenfolge
Manager	Details zum zugeordneten Manager des Anwenders. Datentyp: Objekt "manager": { "display": "String", "value": "String", "$ref": "String" }
manager.Anzeige	Name des Managers. Datentyp: Zeichenfolge
manager.Wert	SYS_ID des Managerdatensatzes. Datentyp: Zeichenfolge
manager.$ref	Referenz-URI für den Manager. Datentyp: Zeichenfolge

Curl-Anforderung mit sys_ID des Anwenders

Das folgende Beispiel zeigt, wie Sie einen bestimmten Anwenderdatensatz erhalten, indem Sie seine sys_ID übergeben

curl "https://instance-servicenow.com/api/now/scim/Users/62826bf03710200044e0bfc8bcbe5df1" \
--request GET \
--header "Accept:application/scim+json" \

Antwort:

{"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: PATCH /scim/Users/{user_ID}

Ermöglicht Ihnen das Hinzufügen, Ersetzen und Entfernen angegebener Felder in einem Anwenderdatensatz in der Anwendertabelle [sys_user] von ServiceNow Instanz, die das SCIM-Protokoll (System for Domain Identity Management) verwendet.

URL-Format

Versionierte URL: /api/now/{api_Version}/scim/Users/{user_ID}

Standard-URL: /api/now/scim/Users/{user_ID}

Hinweis:

Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

Unterstützte Anforderungsparameter

Tabelle : 67. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
user_id	SYS_ID des zu ändernden Anwenderdatensatzes. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user]

Tabelle : 68. Abfrageparameter

Name	Beschreibung
Attribute	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit verwendet werden excludedAttributesParameter. Datentyp: Zeichenfolge Standard: Alle Felder zurückgeben, es sei denn excludedAttributesIst angegeben.
Exklusive Attribute	Kommagetrennte Liste von Feldern, die aus den in der Antwort zurückgegebenen Datensätzen ausgeschlossen werden sollen. Alle anderen Felder werden zurückgegeben. Kann nicht mit verwendet werden attributesParameter. Datentyp: Zeichenfolge Standard: Schließen Sie keine Felder aus.

Tabelle : 69. Anforderungstext-Parameter (JSON)

Name	Beschreibung
Vorgänge	Erforderlich. Liste der Vorgangsobjekte, mit denen der angegebene Anwenderdatensatz gepatcht werden soll. Datentyp: Array "Operations": [ { "op": "String", "path": "String", "value": Any } ]
Vorgänge.OP	Erforderlich. Auszuführender Vorgang. Gültige Werte: Hinzufügen: Fügen Sie dem Anwenderdatensatz das angegebene Feld und den angegebenen Wert hinzu. Entfernen: Entfernen Sie den Wert aus dem angegebenen Feld. Ersetzen: Ersetzen Sie den Wert des angegebenen Felds. Datentyp: Zeichenfolge
Vorgänge.Pfad	Erforderlich für Entfernen Vorgänge. Name/Pfad des zu ändernden Felds. Die pathParameter kann eines der folgenden Formate haben: Ein direktes Feld, z. B. Titel Ein geschachteltes Feld, z. B. Name.givenName Bei einem komplexen Array kann es mit einem Filter auf ein bestimmtes Element verweisen, z. B.: E-Mails[Typ eq „Arbeit“] { "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]" } ] } Datentyp: Zeichenfolge Standard: Betrachtet das Feld als Anwenderressource.
Vorgänge.Wert	Wert des in angegebenen Felds Operations.pathParameter. Das Format dieses Parameters hängt vom Datentyp des zugehörigen Felds ab. Wenn Sie beispielsweise eine einfache Zeichenfolge aktualisieren, z. B. den Titel, die valueFeld wird als Zeichenfolge ausgedrückt. "Operations": [ { "op": "add", "path": "title", "value": "xyz" } ] Sie können auch einfache Zeichenfolgenwerte deklarieren, ohne zu verwenden valueOder pathParameter, z. B.: "Operations": [ { "op": "add", "title": "xyz" } ] Beim Aktualisieren einer Telefonnummer, bei der es sich um ein Array handelt, das Objekte enthält, die zusätzliche Felder definieren, die dem Anwenderdatensatz hinzugefügt werden sollen, und die zugehörigen Werte valueFeld wird als Array von Objekten ausgedrückt. "Operations": [ { "op": "add", "path": "phoneNumbers", "value": [ { "type": "work", "value": "9876543210" }, { "type": "home", "value": "9876783216" } ] } ] Wenn Sie Attributknoten angeben, kann der Eintrag die Verschachtelung wie folgt enthalten: { "op": "replace", "value": { "name": { "familyName": "Jones", "givenName": "Jennifer" } } } Oder Sie können die Verschachtelung in angeben Operations.path: { "op": "replace", "path": "name.givenName", "value": "Jennifer" } Wenn sich das zu aktualisierende Feld nicht im Basisschema befindet, müssen Sie das Name-Wert-Paar in ein Objekt einschließen, das den URN des zugeordneten Schemas angibt. "value": { "<schema_urn>": { "<field_name>": "<new_value>" }, } Zum Beispiel: "value": { "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User": { "employeeNumber": "13454" }, } Datentyp: Beliebig
Vorgänge.Wert.Typ	Name des zu aktualisierenden Felds. Datentyp: Zeichenfolge
Vorgänge.Wert.Wert	Wert, mit dem das Feld aktualisiert werden soll. Datentyp: Zeichenfolge
Schemas	Erforderlich. SCIM-Schema-URI des Patch-Vorgangs URN:ietf:params:scim:api:messages:2,0:PatchOp . Datentyp: Zeichenfolge

Header

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 70. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/scim+json. Standard: application/json
Content-Type	Datenformat des Anforderungstexts. Unterstützte Typen: application/jsonOder application/scim+json. Standard: application/json

Tabelle : 71. Antwortkopfzeilen

Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

Tabelle : 72. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. Auf ungültige Werte prüfen: Fehlerhafter Anforderungstext. Pflichtfeld ist nicht angegeben oder leer. Ungültige Anwender- oder Gruppen-sys_ID angegeben. Überprüfen Sie, ob ein schreibgeschütztes oder unveränderliches Feld versucht, geändert zu werden. Stellen Sie sicher, dass beide attributesUnd excludedAttributesAbfrageparameter wurden in der Anforderung nicht übergeben, oder dass die Anforderung die maximale Anzahl von Mitgliedern nicht überschreitet.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
409	Anwender ist bereits vorhanden. Die userNameParameter muss eindeutig sein.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
aktiv	Kennzeichnung, die angibt, ob der zugeordnete Anwender in aktiv ist ServiceNow Instanz. Mögliche Werte: Wahr: Anwender ist aktiv. Falsch: Anwender ist inaktiv. Datentyp: Boolesch
addresses	Details zur aktuellen Mailadresse des Anwenders. Datentyp: Objekt "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" }
Adressen.Land	Ländername. Datentyp: Zeichenfolge
Adressen.Ort	Name der Stadt oder des Orts. Datentyp: Zeichenfolge
Adressen.Postcode	Postleitzahl. Datentyp: Zeichenfolge
Adressen.Region	Bundesland oder Region. Datentyp: Zeichenfolge
Adressen.streetAdresse	Vollständige Adresse mit Straße und Hausnummer. Dies kann Hausnummer, Straßenname, Postfach und mehrzeilige erweiterte Straßennutzungsinformationen umfassen. Datentyp: Zeichenfolge
Adressen.Typ	Typ der Adresse. Derzeit nur unterstützt Startseite . Datentyp: Zeichenfolge
displayName	Anwenderanzeigename. Dieser Wert wird durch Verkettung von automatisch generiert nameFelder. Datentyp: Zeichenfolge
E-Mails	Liste der E-Mail-Accounts, die dem Anwender zugeordnet sind. Datentyp: Array von Objekten "emails:" [ { "type": "String", "value": "String" } ]
E-Mails.Typ	Anwender-E-Mail-Typ. Unterstützt derzeit nur den Typ „Arbeit“. Datentyp: Zeichenfolge
E-Mails.Wert	E-Mail-Adresse des Anwenders. Dies ist ein eindeutiger Schlüssel für den zugeordneten Anwender. Datentyp: Zeichenfolge
Fehler	Antwort, die alle Fehler beschreibt, die während der Verarbeitung der Anforderung aufgetreten sind. Datentyp: Objekt "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" }
errors.detail	Detaillierte Fehlermeldung, warum die Anforderung fehlgeschlagen ist. Datentyp: Zeichenfolge
Fehler.scimType	Stichwort für SCIM-Fehlerdetail. Datentyp: Zeichenfolge
Fehler.Schemas	URI der SCIM-Schemas, die zur Verarbeitung der Fehlerantwort verwendet werden. Datentyp: Array von Zeichenfolgen
Fehler.Status	HTTP-Statuscode für die Fehlerantwort. Datentyp: Zeichenfolge
externalId	Eindeutiger Bezeichner, der dem Anwender von der Entität zugewiesen wurde, die ihn bereitstellt. Datentyp: Zeichenfolge
groups	Liste der Gruppen, denen der Anwender angehört, entweder durch direkte Mitgliedschaft, geschachtelte Gruppen oder dynamisch berechnet. Datentyp: Array von Objekten "groups": [ { "display": "String", "type": "String", "value": "String", "$ref": "String" } ]
Gruppen.Anzeige	Name der zugeordneten Gruppe. Datentyp: Zeichenfolge
Gruppen.Typ	Typ der Gruppenzuordnung, z. B. direkt oder indirekt. Datentyp: Zeichenfolge
Gruppen.Wert	SYS_ID eines zugeordneten Gruppendatensatzes. Datentyp: Zeichenfolge
Gruppen.$ref	URI der zugeordneten Gruppe. Datentyp: Zeichenfolge
id	SYS_ID des zugehörigen Anwenderdatensatzes. Datentyp: Zeichenfolge
meta	Metadaten, die sich auf den Anwender beziehen. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
Meta.erstellt	Datum und Uhrzeit der Erstellung des Anwenderdatensatzes. Datentyp: Zeichenfolge
Meta.lastModifiziert	Datum und Uhrzeit der letzten Änderung des Anwenderdatensatzes. Datentyp: Zeichenfolge
Meta.location	URI des abgerufenen Anwenders. Datentyp: Zeichenfolge
Meta.resourceType	Ressourcentyp von SCIM-Anwendern. Datentyp: Zeichenfolge
name	Informationen zum Anwendernamen. Datentyp: Objekt "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" }
Name.FAMILYNAME	Familie oder Nachname des Anwenders. Datentyp: Zeichenfolge
Name.givenName	Vorname oder Vorname des Anwenders. Datentyp: Zeichenfolge
Name.HonorificPräfix	Ehrenvoller Name oder Titel des Anwenders, z. B. Dr., Bishop oder Baron. Datentyp: Zeichenfolge
Name.Mitte	Zweiter Vorname des Anwenders. Datentyp: Zeichenfolge
phoneNumbers	Liste der Telefonnummern, die dem Anwender zugeordnet sind. Datentyp: Array von Objekten "phoneNumbers": [ { "type": "String", "value": "String" } ]
Telefonnummern.Typ	Typ der Telefonnummer. Mögliche Werte: Homepage Mobile Arbeit Datentyp: Zeichenfolge
Telefonnummern.Wert	Telefonnummer des Anwenders. Datentyp: Zeichenfolge
Bevorzugte Sprache	Bevorzugte gesprochene und schriftliche Sprache des Anwenders. Datentyp: Zeichenfolge
Schemas	Liste der URIs der SCIM-Anwenderschemata, die zur Verarbeitung der Anforderung verwendet werden. Datentyp: Array von Zeichenfolgen
Feld	Zeitzone des Anwenders. Datentyp: Zeichenfolge
Titel	Titel des Anwenders, z. B. CEO oder Präsident. Datentyp: Zeichenfolge
userName	Eindeutiger Anwendername für den zugeordneten Anwender. Datentyp: Zeichenfolge
Anwendertyp	Anwendertyp. Dieser Wert wird verwendet, um die Beziehung zwischen Organisation und Anwender zu identifizieren. Dies kann ein beliebiger Wert sein, typische Werte können jedoch Folgendes sein: Vertragsunternehmen Mitarbeiter Praktikanten Temp Extern Unbekannt Datentyp: Zeichenfolge

Erweiterungsparameter zurückgegeben

Name	Beschreibung
Unternehmen	Details zum zugehörigen Unternehmen des Anwenders. Datentyp: Objekt "company": { "display": "String", "value": "String", "$ref": "String" }
Unternehmen.Anzeige	Name des Unternehmens. Datentyp: Zeichenfolge
Unternehmen.Wert	SYS_ID des Unternehmensdatensatzes. Datentyp: Zeichenfolge
Unternehmen.$Ref	Referenz-URI für das Unternehmen. Datentyp: Zeichenfolge
Kostenstelle	Details zur zugeordneten Kostenstelle des Anwenders. Datentyp: Objekt "costCenter": { "display": "String", "value": "String", "$ref": "String" }
Kostenstelle.Anzeige	Name der Kostenstelle. Datentyp: Zeichenfolge
Kostenstelle.Wert	SYS_ID des Kostenstellendatensatzes. Datentyp: Zeichenfolge
CostCenter.$ref	Referenz-URI für die Kostenstelle. Datentyp: Zeichenfolge
department	Details zur zugehörigen Abteilung des Anwenders. Datentyp: Objekt "department": { "display": "String", "value": "String", "$ref": "String" }
Abteilung.Anzeige	Name der Abteilung. Datentyp: Zeichenfolge
Abteilung.Wert	SYS_ID des Abteilungsdatensatzes. Datentyp: Zeichenfolge
Abteilung.$ref	Referenz-URI für die Abteilung. Datentyp: Zeichenfolge
Mitarbeiternummer	Numerische oder alphanumerische Personalnummer. Datentyp: Zeichenfolge
Geschlecht	Geschlecht des Anwenders, z. B. männlich oder weiblich. Datentyp: Zeichenfolge
location	Details zum zugehörigen Standort des Anwenders. Datentyp: Objekt "location": { "display": "String", "value": "String", "$ref": "String" }
Standort.Anzeige	Name des Standorts. Datentyp: Zeichenfolge
Standort.Wert	SYS_ID des Standortdatensatzes. Datentyp: Zeichenfolge
Standort.$ref	Referenz-URI für den Standort. Datentyp: Zeichenfolge
Manager	Details zum zugeordneten Manager des Anwenders. Datentyp: Objekt "manager": { "display": "String", "value": "String", "$ref": "String" }
manager.Anzeige	Name des Managers. Datentyp: Zeichenfolge
manager.Wert	SYS_ID des Managerdatensatzes. Datentyp: Zeichenfolge
manager.$ref	Referenz-URI für den Manager. Datentyp: Zeichenfolge

cURL-Anforderung

Das folgende Beispiel zeigt, wie Werte in einem Anwenderdatensatz hinzugefügt, entfernt und ersetzt werden.

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

Antwort:

{
  "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: POST /scim/Users

Erstellt einen Anwenderdatensatz in der Anwendertabelle [sys_user] von ServiceNow Instanz, die das SCIM-Protokoll (System for Domain Identity Management) verwendet.

Hinweis:

Die in der RFC7643-Spezifikation angegebenen Such- und Massenänderungen werden von diesem Endpunkt nicht unterstützt.

URL-Format

Versionierte URL: /api/now/{api_Version}/scim/Users

Standard-URL: /api/now/scim/Users

Hinweis:

Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

Unterstützte Anforderungsparameter

Tabelle : 73. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 74. Abfrageparameter

Name	Beschreibung
Attribute	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit verwendet werden excludedAttributesParameter. Datentyp: Zeichenfolge Standard: Alle Felder zurückgeben, es sei denn excludedAttributesIst angegeben.
Exklusive Attribute	Kommagetrennte Liste von Feldern, die aus den in der Antwort zurückgegebenen Datensätzen ausgeschlossen werden sollen. Alle anderen Felder werden zurückgegeben. Kann nicht mit verwendet werden attributesParameter. Datentyp: Zeichenfolge Standard: Schließen Sie keine Felder aus.

Tabelle : 75. Anforderungstextparameter (XML oder JSON)

Name	Beschreibung
aktiv	Kennzeichnung, die angibt, ob der zugeordnete Anwender in aktiv ist ServiceNow Instanz. Mögliche Werte: Wahr: Anwender ist aktiv. Falsch: Anwender ist inaktiv. Datentyp: Boolesch
addresses	Details zur aktuellen Mailadresse des Anwenders. Datentyp: Objekt "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" }
Adressen.Land	Ländername. Datentyp: Zeichenfolge
Adressen.Ort	Name der Stadt oder des Orts. Datentyp: Zeichenfolge
Adressen.Postcode	Postleitzahl. Datentyp: Zeichenfolge
Adressen.Region	Bundesland oder Region. Datentyp: Zeichenfolge
Adressen.streetAdresse	Vollständige Adresse mit Straße und Hausnummer. Dies kann Hausnummer, Straßenname, Postfach und mehrzeilige erweiterte Straßennutzungsinformationen umfassen. Datentyp: Zeichenfolge
Adressen.Typ	Typ der Adresse. Derzeit nur unterstützt Startseite . Datentyp: Zeichenfolge
displayName	Anwenderanzeigename. Dieser Wert wird durch Verkettung von automatisch generiert nameFelder. Datentyp: Zeichenfolge
E-Mails	Liste der E-Mail-Accounts, die dem Anwender zugeordnet sind. Datentyp: Array von Objekten "emails:" [ { "type": "String", "value": "String" } ]
E-Mails.Typ	Anwender-E-Mail-Typ. Unterstützt derzeit nur den Typ „Arbeit“. Datentyp: Zeichenfolge
E-Mails.Wert	E-Mail-Adresse des Anwenders. Dies ist ein eindeutiger Schlüssel für den zugeordneten Anwender. Datentyp: Zeichenfolge
externalId	Eindeutiger Bezeichner, der dem Anwender von der Entität zugewiesen wurde, die ihn bereitstellt. Datentyp: Zeichenfolge
name	Informationen zum Anwendernamen. Datentyp: Objekt "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" }
Name.FAMILYNAME	Familie oder Nachname des Anwenders. Datentyp: Zeichenfolge
Name.givenName	Vorname oder Vorname des Anwenders. Datentyp: Zeichenfolge
Name.HonorificPräfix	Ehrenvoller Name oder Titel des Anwenders, z. B. Dr., Bishop oder Baron. Datentyp: Zeichenfolge
Name.Mitte	Zweiter Vorname des Anwenders. Datentyp: Zeichenfolge
phoneNumbers	Liste der Telefonnummern, die dem Anwender zugeordnet sind. Datentyp: Array von Objekten "phoneNumbers": [ { "type": "String", "value": "String" } ]
Telefonnummern.Typ	Typ der Telefonnummer. Mögliche Werte: Homepage Mobile Arbeit Datentyp: Zeichenfolge
Telefonnummern.Wert	Telefonnummer des Anwenders. Datentyp: Zeichenfolge
Bevorzugte Sprache	Bevorzugte gesprochene und schriftliche Sprache des Anwenders. Datentyp: Zeichenfolge
Feld	Zeitzone des Anwenders. Datentyp: Zeichenfolge
Titel	Titel des Anwenders, z. B. CEO oder Präsident. Datentyp: Zeichenfolge
userName	Erforderlich. Eindeutiger Anwendername für den zugeordneten Anwender. Datentyp: Zeichenfolge
Anwendertyp	Anwendertyp. Dieser Wert wird verwendet, um die Beziehung zwischen Organisation und Anwender zu identifizieren. Dies kann ein beliebiger Wert sein, typische Werte können jedoch Folgendes sein: Vertragsunternehmen Mitarbeiter Praktikanten Temp Extern Unbekannt Datentyp: Zeichenfolge
Erweitertes Schema
Unternehmen	Details zum zugehörigen Unternehmen des Anwenders. Datentyp: Objekt "company": { "value": "String" }
Unternehmen.Wert	Erforderlich, wenn das Unternehmen im Post enthalten ist. SYS_ID des Unternehmensdatensatzes. Datentyp: Zeichenfolge
Kostenstelle	Details zur zugeordneten Kostenstelle des Anwenders. Datentyp: Objekt "costCenter": { "value": "String" }
Kostenstelle.Wert	Erforderlich, wenn CostCenter im Post enthalten ist. SYS_ID des Kostenstellendatensatzes. Datentyp: Zeichenfolge
department	Details zur zugehörigen Abteilung des Anwenders. Datentyp: Objekt "department": { "value": "String" }
Abteilung.Wert	Erforderlich, wenn die Abteilung in der Post enthalten ist. SYS_ID des Abteilungsdatensatzes. Datentyp: Zeichenfolge
Mitarbeiternummer	Numerische oder alphanumerische Personalnummer. Datentyp: Zeichenfolge
Geschlecht	Geschlecht des Anwenders, z. B. männlich oder weiblich. Datentyp: Zeichenfolge
location	Details zum zugehörigen Standort des Anwenders. Datentyp: Objekt "location": { "value": "String" }
Standort.Wert	Erforderlich, wenn der Standort im Post enthalten ist. SYS_ID des Standortdatensatzes. Datentyp: Zeichenfolge
Manager	Details zum zugeordneten Manager des Anwenders. Datentyp: Objekt "manager": { "value": "String" }
manager.Wert	Erforderlich, wenn der Manager im Post enthalten ist. SYS_ID des Managerdatensatzes. Datentyp: Zeichenfolge

Header

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 76. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/scim+json. Standard: application/json
Content-Type	Datenformat des Anforderungstexts. Unterstützte Typen: application/jsonOder application/scim+json. Standard: application/json

Tabelle : 77. Antwortkopfzeilen

Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

Tabelle : 78. Statuscodes

Statuscode	Beschreibung
201	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
409	Anwender ist bereits vorhanden. Die userNameParameter muss eindeutig sein.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
aktiv	Kennzeichnung, die angibt, ob der zugeordnete Anwender in aktiv ist ServiceNow Instanz. Mögliche Werte: Wahr: Anwender ist aktiv. Falsch: Anwender ist inaktiv. Datentyp: Boolesch
addresses	Details zur aktuellen Mailadresse des Anwenders. Datentyp: Objekt "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" }
Adressen.Land	Ländername. Datentyp: Zeichenfolge
Adressen.Ort	Name der Stadt oder des Orts. Datentyp: Zeichenfolge
Adressen.Postcode	Postleitzahl. Datentyp: Zeichenfolge
Adressen.Region	Bundesland oder Region. Datentyp: Zeichenfolge
Adressen.streetAdresse	Vollständige Adresse mit Straße und Hausnummer. Dies kann Hausnummer, Straßenname, Postfach und mehrzeilige erweiterte Straßennutzungsinformationen umfassen. Datentyp: Zeichenfolge
Adressen.Typ	Typ der Adresse. Derzeit nur unterstützt Startseite . Datentyp: Zeichenfolge
displayName	Anwenderanzeigename. Dieser Wert wird durch Verkettung von automatisch generiert nameFelder. Datentyp: Zeichenfolge
E-Mails	Liste der E-Mail-Accounts, die dem Anwender zugeordnet sind. Datentyp: Array von Objekten "emails:" [ { "type": "String", "value": "String" } ]
E-Mails.Typ	Anwender-E-Mail-Typ. Unterstützt derzeit nur den Typ „Arbeit“. Datentyp: Zeichenfolge
E-Mails.Wert	E-Mail-Adresse des Anwenders. Dies ist ein eindeutiger Schlüssel für den zugeordneten Anwender. Datentyp: Zeichenfolge
Fehler	Antwort, die alle Fehler beschreibt, die während der Verarbeitung der Anforderung aufgetreten sind. Datentyp: Objekt "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" }
errors.detail	Detaillierte Fehlermeldung, warum die Anforderung fehlgeschlagen ist. Datentyp: Zeichenfolge
Fehler.scimType	Stichwort für SCIM-Fehlerdetail. Datentyp: Zeichenfolge
Fehler.Schemas	URI der SCIM-Schemas, die zur Verarbeitung der Fehlerantwort verwendet werden. Datentyp: Array von Zeichenfolgen
Fehler.Status	HTTP-Statuscode für die Fehlerantwort. Datentyp: Zeichenfolge
externalId	Eindeutiger Bezeichner, der dem Anwender von der Entität zugewiesen wurde, die ihn bereitstellt. Datentyp: Zeichenfolge
groups	Liste der Gruppen, denen der Anwender angehört, entweder durch direkte Mitgliedschaft, geschachtelte Gruppen oder dynamisch berechnet. Datentyp: Array von Objekten "groups": [ { "display": "String", "type": "String", "value": "String", "$ref": "String" } ]
Gruppen.Anzeige	Name der zugeordneten Gruppe. Datentyp: Zeichenfolge
Gruppen.Typ	Typ der Gruppenzuordnung, z. B. direkt oder indirekt. Datentyp: Zeichenfolge
Gruppen.Wert	SYS_ID eines zugeordneten Gruppendatensatzes. Datentyp: Zeichenfolge
Gruppen.$ref	URI der zugeordneten Gruppe. Datentyp: Zeichenfolge
id	SYS_ID des zugehörigen Anwenderdatensatzes. Datentyp: Zeichenfolge
meta	Metadaten, die sich auf den Anwender beziehen. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
Meta.erstellt	Datum und Uhrzeit der Erstellung des Anwenderdatensatzes. Datentyp: Zeichenfolge
Meta.lastModifiziert	Datum und Uhrzeit der letzten Änderung des Anwenderdatensatzes. Datentyp: Zeichenfolge
Meta.location	URI des abgerufenen Anwenders. Datentyp: Zeichenfolge
Meta.resourceType	Ressourcentyp von SCIM-Anwendern. Datentyp: Zeichenfolge
name	Informationen zum Anwendernamen. Datentyp: Objekt "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" }
Name.FAMILYNAME	Familie oder Nachname des Anwenders. Datentyp: Zeichenfolge
Name.givenName	Vorname oder Vorname des Anwenders. Datentyp: Zeichenfolge
Name.HonorificPräfix	Ehrenvoller Name oder Titel des Anwenders, z. B. Dr., Bishop oder Baron. Datentyp: Zeichenfolge
Name.Mitte	Zweiter Vorname des Anwenders. Datentyp: Zeichenfolge
phoneNumbers	Liste der Telefonnummern, die dem Anwender zugeordnet sind. Datentyp: Array von Objekten "phoneNumbers": [ { "type": "String", "value": "String" } ]
Telefonnummern.Typ	Typ der Telefonnummer. Mögliche Werte: Homepage Mobile Arbeit Datentyp: Zeichenfolge
Telefonnummern.Wert	Telefonnummer des Anwenders. Datentyp: Zeichenfolge
Bevorzugte Sprache	Bevorzugte gesprochene und schriftliche Sprache des Anwenders. Datentyp: Zeichenfolge
Schemas	Liste der URIs der SCIM-Anwenderschemata, die zur Verarbeitung der Anforderung verwendet werden. Datentyp: Array von Zeichenfolgen
Feld	Zeitzone des Anwenders. Datentyp: Zeichenfolge
Titel	Titel des Anwenders, z. B. CEO oder Präsident. Datentyp: Zeichenfolge
userName	Eindeutiger Anwendername für den zugeordneten Anwender. Datentyp: Zeichenfolge
Anwendertyp	Anwendertyp. Dieser Wert wird verwendet, um die Beziehung zwischen Organisation und Anwender zu identifizieren. Dies kann ein beliebiger Wert sein, typische Werte können jedoch Folgendes sein: Vertragsunternehmen Mitarbeiter Praktikanten Temp Extern Unbekannt Datentyp: Zeichenfolge

Curl-Anforderung zum POSTEN DES Anwenders

Dieses Beispiel zeigt, wie der Anwender Jack Sparrow in der Anwendertabelle [sys_user] VERÖFFENTLICHT wird.

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
      }
    ]
}'

Antwort:

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

Aktualisiert den angegebenen Anwenderdatensatz in der Anwendertabelle [sys_user] von ServiceNow Instanz, die das SCIM-Protokoll (System for Domain Identity Management) verwendet.

URL-Format

Versionierte URL: /api/now/{api_Version}/scim/Users/{user_ID}

Standard-URL: /api/now/scim/Users/{user_ID}

Hinweis:

Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

Unterstützte Anforderungsparameter

Tabelle : 79. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
user_id	SYS_ID des zu aktualisierenden Anwenderdatensatzes. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user]

Tabelle : 80. Abfrageparameter

Name	Beschreibung
Attribute	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit verwendet werden excludedAttributesParameter. Datentyp: Zeichenfolge Standard: Alle Felder zurückgeben, es sei denn excludedAttributesIst angegeben.
Exklusive Attribute	Kommagetrennte Liste von Feldern, die aus den in der Antwort zurückgegebenen Datensätzen ausgeschlossen werden sollen. Alle anderen Felder werden zurückgegeben. Kann nicht mit verwendet werden attributesParameter. Datentyp: Zeichenfolge Standard: Schließen Sie keine Felder aus.

Tabelle : 81. Anforderungstext-Parameter (JSON)

Name	Beschreibung
aktiv	Kennzeichnung, die angibt, ob der zugeordnete Anwender in aktiv ist ServiceNow Instanz. Mögliche Werte: Wahr: Anwender ist aktiv. Falsch: Anwender ist inaktiv. Datentyp: Boolesch
addresses	Details zur aktuellen Mailadresse des Anwenders. Datentyp: Objekt "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" }
Adressen.Land	Ländername. Datentyp: Zeichenfolge
Adressen.Ort	Name der Stadt oder des Orts. Datentyp: Zeichenfolge
Adressen.Postcode	Postleitzahl. Datentyp: Zeichenfolge
Adressen.Region	Bundesland oder Region. Datentyp: Zeichenfolge
Adressen.streetAdresse	Vollständige Adresse mit Straße und Hausnummer. Dies kann Hausnummer, Straßenname, Postfach und mehrzeilige erweiterte Straßennutzungsinformationen umfassen. Datentyp: Zeichenfolge
Adressen.Typ	Typ der Adresse. Derzeit nur unterstützt Startseite . Datentyp: Zeichenfolge
displayName	Anwenderanzeigename. Dieser Wert wird durch Verkettung von automatisch generiert nameFelder. Datentyp: Zeichenfolge
E-Mails	Liste der E-Mail-Accounts, die dem Anwender zugeordnet sind. Datentyp: Array von Objekten "emails:" [ { "type": "String", "value": "String" } ]
E-Mails.Typ	Anwender-E-Mail-Typ. Unterstützt derzeit nur den Typ „Arbeit“. Datentyp: Zeichenfolge
E-Mails.Wert	E-Mail-Adresse des Anwenders. Dies ist ein eindeutiger Schlüssel für den zugeordneten Anwender. Datentyp: Zeichenfolge
externalId	Eindeutiger Bezeichner, der dem Anwender von der Entität zugewiesen wurde, die ihn bereitstellt. Datentyp: Zeichenfolge
name	Informationen zum Anwendernamen. Datentyp: Objekt "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" }
Name.FAMILYNAME	Familie oder Nachname des Anwenders. Datentyp: Zeichenfolge
Name.givenName	Vorname oder Vorname des Anwenders. Datentyp: Zeichenfolge
Name.HonorificPräfix	Ehrenvoller Name oder Titel des Anwenders, z. B. Dr., Bishop oder Baron. Datentyp: Zeichenfolge
Name.Mitte	Zweiter Vorname des Anwenders. Datentyp: Zeichenfolge
phoneNumbers	Liste der Telefonnummern, die dem Anwender zugeordnet sind. Datentyp: Array von Objekten "phoneNumbers": [ { "type": "String", "value": "String" } ]
Telefonnummern.Typ	Typ der Telefonnummer. Mögliche Werte: Homepage Mobile Arbeit Datentyp: Zeichenfolge
Telefonnummern.Wert	Telefonnummer des Anwenders. Datentyp: Zeichenfolge
Bevorzugte Sprache	Bevorzugte gesprochene und schriftliche Sprache des Anwenders. Datentyp: Zeichenfolge
Feld	Zeitzone des Anwenders. Datentyp: Zeichenfolge
Titel	Titel des Anwenders, z. B. CEO oder Präsident. Datentyp: Zeichenfolge
userName	Erforderlich. Eindeutiger Anwendername für den zugeordneten Anwender. Datentyp: Zeichenfolge
Anwendertyp	Anwendertyp. Dieser Wert wird verwendet, um die Beziehung zwischen Organisation und Anwender zu identifizieren. Dies kann ein beliebiger Wert sein, typische Werte können jedoch Folgendes sein: Vertragsunternehmen Mitarbeiter Praktikanten Temp Extern Unbekannt Datentyp: Zeichenfolge
Erweitertes Schema
Unternehmen	Details zum zugehörigen Unternehmen des Anwenders. Datentyp: Objekt "company": { "value": "String" }
Unternehmen.Wert	Erforderlich, wenn das Unternehmen im Post enthalten ist. SYS_ID des Unternehmensdatensatzes. Datentyp: Zeichenfolge
Kostenstelle	Details zur zugeordneten Kostenstelle des Anwenders. Datentyp: Objekt "costCenter": { "value": "String" }
Kostenstelle.Wert	Erforderlich, wenn CostCenter im Post enthalten ist. SYS_ID des Kostenstellendatensatzes. Datentyp: Zeichenfolge
department	Details zur zugehörigen Abteilung des Anwenders. Datentyp: Objekt "department": { "value": "String" }
Abteilung.Wert	Erforderlich, wenn die Abteilung in der Post enthalten ist. SYS_ID des Abteilungsdatensatzes. Datentyp: Zeichenfolge
Mitarbeiternummer	Numerische oder alphanumerische Personalnummer. Datentyp: Zeichenfolge
Geschlecht	Geschlecht des Anwenders, z. B. männlich oder weiblich. Datentyp: Zeichenfolge
location	Details zum zugehörigen Standort des Anwenders. Datentyp: Objekt "location": { "value": "String" }
Standort.Wert	Erforderlich, wenn der Standort im Post enthalten ist. SYS_ID des Standortdatensatzes. Datentyp: Zeichenfolge
Manager	Details zum zugeordneten Manager des Anwenders. Datentyp: Objekt "manager": { "value": "String" }
manager.Wert	Erforderlich, wenn der Manager im Post enthalten ist. SYS_ID des Managerdatensatzes. Datentyp: Zeichenfolge

Header

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 82. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/scim+json. Standard: application/json
Content-Type	Datenformat des Anforderungstexts. Unterstützte Typen: application/jsonOder application/scim+json. Standard: application/json

Tabelle : 83. Antwortkopfzeilen

Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

Tabelle : 84. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
409	Anwender ist bereits vorhanden. Die userNameParameter muss eindeutig sein.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
aktiv	Kennzeichnung, die angibt, ob der zugeordnete Anwender in aktiv ist ServiceNow Instanz. Mögliche Werte: Wahr: Anwender ist aktiv. Falsch: Anwender ist inaktiv. Datentyp: Boolesch
addresses	Details zur aktuellen Mailadresse des Anwenders. Datentyp: Objekt "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" }
Adressen.Land	Ländername. Datentyp: Zeichenfolge
Adressen.Ort	Name der Stadt oder des Orts. Datentyp: Zeichenfolge
Adressen.Postcode	Postleitzahl. Datentyp: Zeichenfolge
Adressen.Region	Bundesland oder Region. Datentyp: Zeichenfolge
Adressen.streetAdresse	Vollständige Adresse mit Straße und Hausnummer. Dies kann Hausnummer, Straßenname, Postfach und mehrzeilige erweiterte Straßennutzungsinformationen umfassen. Datentyp: Zeichenfolge
Adressen.Typ	Typ der Adresse. Derzeit nur unterstützt Startseite . Datentyp: Zeichenfolge
displayName	Anwenderanzeigename. Dieser Wert wird durch Verkettung von automatisch generiert nameFelder. Datentyp: Zeichenfolge
E-Mails	Liste der E-Mail-Accounts, die dem Anwender zugeordnet sind. Datentyp: Array von Objekten "emails:" [ { "type": "String", "value": "String" } ]
E-Mails.Typ	Anwender-E-Mail-Typ. Unterstützt derzeit nur den Typ „Arbeit“. Datentyp: Zeichenfolge
E-Mails.Wert	E-Mail-Adresse des Anwenders. Dies ist ein eindeutiger Schlüssel für den zugeordneten Anwender. Datentyp: Zeichenfolge
Fehler	Antwort, die alle Fehler beschreibt, die während der Verarbeitung der Anforderung aufgetreten sind. Datentyp: Objekt "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" }
errors.detail	Detaillierte Fehlermeldung, warum die Anforderung fehlgeschlagen ist. Datentyp: Zeichenfolge
Fehler.scimType	Stichwort für SCIM-Fehlerdetail. Datentyp: Zeichenfolge
Fehler.Schemas	URI der SCIM-Schemas, die zur Verarbeitung der Fehlerantwort verwendet werden. Datentyp: Array von Zeichenfolgen
Fehler.Status	HTTP-Statuscode für die Fehlerantwort. Datentyp: Zeichenfolge
externalId	Eindeutiger Bezeichner, der dem Anwender von der Entität zugewiesen wurde, die ihn bereitstellt. Datentyp: Zeichenfolge
groups	Liste der Gruppen, denen der Anwender angehört, entweder durch direkte Mitgliedschaft, geschachtelte Gruppen oder dynamisch berechnet. Datentyp: Array von Objekten "groups": [ { "display": "String", "type": "String", "value": "String", "$ref": "String" } ]
Gruppen.Anzeige	Name der zugeordneten Gruppe. Datentyp: Zeichenfolge
Gruppen.Typ	Typ der Gruppenzuordnung, z. B. direkt oder indirekt. Datentyp: Zeichenfolge
Gruppen.Wert	SYS_ID eines zugeordneten Gruppendatensatzes. Datentyp: Zeichenfolge
Gruppen.$ref	URI der zugeordneten Gruppe. Datentyp: Zeichenfolge
id	SYS_ID des zugehörigen Anwenderdatensatzes. Datentyp: Zeichenfolge
meta	Metadaten, die sich auf den Anwender beziehen. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
Meta.erstellt	Datum und Uhrzeit der Erstellung des Anwenderdatensatzes. Datentyp: Zeichenfolge
Meta.lastModifiziert	Datum und Uhrzeit der letzten Änderung des Anwenderdatensatzes. Datentyp: Zeichenfolge
Meta.location	URI des abgerufenen Anwenders. Datentyp: Zeichenfolge
Meta.resourceType	Ressourcentyp von SCIM-Anwendern. Datentyp: Zeichenfolge
name	Informationen zum Anwendernamen. Datentyp: Objekt "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" }
Name.FAMILYNAME	Familie oder Nachname des Anwenders. Datentyp: Zeichenfolge
Name.givenName	Vorname oder Vorname des Anwenders. Datentyp: Zeichenfolge
Name.HonorificPräfix	Ehrenvoller Name oder Titel des Anwenders, z. B. Dr., Bishop oder Baron. Datentyp: Zeichenfolge
Name.Mitte	Zweiter Vorname des Anwenders. Datentyp: Zeichenfolge
phoneNumbers	Liste der Telefonnummern, die dem Anwender zugeordnet sind. Datentyp: Array von Objekten "phoneNumbers": [ { "type": "String", "value": "String" } ]
Telefonnummern.Typ	Typ der Telefonnummer. Mögliche Werte: Homepage Mobile Arbeit Datentyp: Zeichenfolge
Telefonnummern.Wert	Telefonnummer des Anwenders. Datentyp: Zeichenfolge
Bevorzugte Sprache	Bevorzugte gesprochene und schriftliche Sprache des Anwenders. Datentyp: Zeichenfolge
Schemas	Liste der URIs der SCIM-Anwenderschemata, die zur Verarbeitung der Anforderung verwendet werden. Datentyp: Array von Zeichenfolgen
Feld	Zeitzone des Anwenders. Datentyp: Zeichenfolge
Titel	Titel des Anwenders, z. B. CEO oder Präsident. Datentyp: Zeichenfolge
userName	Eindeutiger Anwendername für den zugeordneten Anwender. Datentyp: Zeichenfolge
Anwendertyp	Anwendertyp. Dieser Wert wird verwendet, um die Beziehung zwischen Organisation und Anwender zu identifizieren. Dies kann ein beliebiger Wert sein, typische Werte können jedoch Folgendes sein: Vertragsunternehmen Mitarbeiter Praktikanten Temp Extern Unbekannt Datentyp: Zeichenfolge

Erweiterungsparameter zurückgegeben

Name	Beschreibung
Unternehmen	Details zum zugehörigen Unternehmen des Anwenders. Datentyp: Objekt "company": { "display": "String", "value": "String", "$ref": "String" }
Unternehmen.Anzeige	Name des Unternehmens. Datentyp: Zeichenfolge
Unternehmen.Wert	SYS_ID des Unternehmensdatensatzes. Datentyp: Zeichenfolge
Unternehmen.$Ref	Referenz-URI für das Unternehmen. Datentyp: Zeichenfolge
Kostenstelle	Details zur zugeordneten Kostenstelle des Anwenders. Datentyp: Objekt "costCenter": { "display": "String", "value": "String", "$ref": "String" }
Kostenstelle.Anzeige	Name der Kostenstelle. Datentyp: Zeichenfolge
Kostenstelle.Wert	SYS_ID des Kostenstellendatensatzes. Datentyp: Zeichenfolge
CostCenter.$ref	Referenz-URI für die Kostenstelle. Datentyp: Zeichenfolge
department	Details zur zugehörigen Abteilung des Anwenders. Datentyp: Objekt "department": { "display": "String", "value": "String", "$ref": "String" }
Abteilung.Anzeige	Name der Abteilung. Datentyp: Zeichenfolge
Abteilung.Wert	SYS_ID des Abteilungsdatensatzes. Datentyp: Zeichenfolge
Abteilung.$ref	Referenz-URI für die Abteilung. Datentyp: Zeichenfolge
Mitarbeiternummer	Numerische oder alphanumerische Personalnummer. Datentyp: Zeichenfolge
Geschlecht	Geschlecht des Anwenders, z. B. männlich oder weiblich. Datentyp: Zeichenfolge
location	Details zum zugehörigen Standort des Anwenders. Datentyp: Objekt "location": { "display": "String", "value": "String", "$ref": "String" }
Standort.Anzeige	Name des Standorts. Datentyp: Zeichenfolge
Standort.Wert	SYS_ID des Standortdatensatzes. Datentyp: Zeichenfolge
Standort.$ref	Referenz-URI für den Standort. Datentyp: Zeichenfolge
Manager	Details zum zugeordneten Manager des Anwenders. Datentyp: Objekt "manager": { "display": "String", "value": "String", "$ref": "String" }
manager.Anzeige	Name des Managers. Datentyp: Zeichenfolge
manager.Wert	SYS_ID des Managerdatensatzes. Datentyp: Zeichenfolge
manager.$ref	Referenz-URI für den Manager. Datentyp: Zeichenfolge

Curl-Anforderung zum Aktualisieren von Anwenderinformationen mithilfe von PUT

Dieses Beispiel zeigt, wie die Informationen eines vorhandenen Anwenders mithilfe des PUT-Endpunkts aktualisiert werden.

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

Antwort:

{
  "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: /scim/ResourceTypes ABRUFEN

Ruft Informationen zu allen vom zugeordneten System for Domain Identity Management (SCIM)-Ressourcentypen ab ServiceNow Instanz.

Dies ist ein öffentlicher Endpunkt und erfordert keine Rollen für den Zugriff.

URL-Format

Versionierte URL: /api/now/{api_Version}/scim/ResourceTypes

Standard-URL: /api/now/scim/ResourceTypes

Hinweis:

Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

Unterstützte Anforderungsparameter

Tabelle : 85. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 86. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 87. Anforderungstext-Parameter (JSON)

Name	Beschreibung
Keine

Kopfzeilen

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 88. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/scim+json. Standard: application/json

Tabelle : 89. Antwortkopfzeilen

Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

Tabelle : 90. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
ItemsPerPage	Anzahl der in den Rückgabeergebnissen zurückgegebenen Datensätze. Datentyp: Zahl
Ressourcen	Liste der verfügbaren Ressourcentypen. Datentyp: Array von Objekten "Resources": [ { "description": "String", "endpoint": "String", "id": "String", "meta": {Object}, "name": "String", "schema": "String" "schemas": [Array], "schemaExtensions": [Array] } ]
Resources.description	Kurze Beschreibung des Ressourcentyps. Datentyp: Zeichenfolge
Ressourcen.Endpunkt	Name des HTTP-adressierbaren Endpunkts relativ zur Basis-URL des Service Providers, z. B. „Anwender“. Datentyp: Zeichenfolge
Ressourcen.ID	Eindeutiger Bezeichner für die Ressource. Verwenden Sie dieses Attribut beim Aufrufen des Endpunkts GET /scim/ResourceType/{resource_ID}. Datentyp: Zeichenfolge
Ressourcen.Meta	Informationen, die die zugeordnete Ressource weiter beschreiben. Datentyp: Objekt "metadata": { "location": "String", "resourceType": "String" }
Ressourcen.Meta.Standort	URI des zugeordneten Ressourcentyps auf dem zugeordneten ServiceNow Instanz. Datentyp: Zeichenfolge
Ressourcen.Meta.resourceType	Immer „ResourceType“. Datentyp: Zeichenfolge
Resources.name	Name des Ressourcentyps, z. B. Anwender oder Gruppe. Datentyp: Zeichenfolge
Ressourcen.Schema	Primärer/Basisschema-URI des Ressourcentyps. Beispiel: „URN:ietf:Parameters:scim:Schemas:Core:2,0:Anwender“ . Datentyp: Zeichenfolge
Ressourcen.Schemas	Schema, das zum Verarbeiten von verwendet wird /ResourceType Anforderung. Beispiel: „URN:ietf:params:scim:Schemas:Core:2,0:ResourceType“ . Datentyp: Zeichenfolge
Ressourcen.schemaErweiterungen	Liste der Schemaerweiterungen, die für den zugehörigen Ressourcentyp gelten. Beispiel: „URN:ietf:params:scim:Schemas:Extension: servicenow:2,0:User“ . Datentyp: Array des Objekts "schemaExtensions": { "required": Boolean, "schema": "String" }
Ressourcen.SchemaErweiterungen.erforderlich	Kennzeichnung, die angibt, ob die Schemaerweiterung für den Ressourcentyp erforderlich ist. Mögliche Werte: Wahr: Eine Ressource dieses Typs muss diese Schemaerweiterung und auch alle Attribute enthalten, die in dieser Schemaerweiterung als erforderlich deklariert sind. Falsch: Eine Ressource dieses Typs kann diese Schemaerweiterung auslassen. Datentyp: Boolesch
Ressourcen.schemaErweiterungen.Schema	URI eines erweiterten Schemas. Beispiel: „URN:ietf:params:scim:Schemas:Extension: servicenow:2,0:User“ . Datentyp: Zeichenfolge
Schemas	Schema, das zum Verarbeiten der Listenantwort auf die Anforderung verwendet wird. Beispiel: „URN:ietf:Parameters:scim:api:Messages:2,0:ListResponse“ Datentyp: Zeichenfolge
startIndex	Einbasierter Index in der Ressourcentabelle, mit dem Datensätze abgerufen wurden. Datentyp: Zeichenfolge
totalResults	Gesamtanzahl der Datensätze, die der Anforderung entsprechen. Datentyp: Zahl

cURL-Anforderung

Das folgende Beispiel zeigt, wie Sie die von unterstützten SCIM-Ressourcentypen abrufen ServiceNow Instanz.

curl "https://instance-servicenow.com/api/now/scim/ResourceTypes \
--request GET \
--header "Accept:application/scim+json" \

Antwort:

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

Ruft Informationen zum angegebenen Ressourcentyp „System für SCIM-übergreifendes Identitätsmanagement“ ab.

Dies ist ein öffentlicher Endpunkt und erfordert keine Rollen für den Zugriff.

URL-Format

Versionierte URL: /api/now/{api_Version}/scim/ResourceTypes/{ResourceName}

Standard-URL: /api/now/scim/ResourceTypes/{ResourceName}

Hinweis:

Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

Unterstützte Anforderungsparameter

Tabelle : 91. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
ResourceName	Eindeutige ID des abzurufenden Ressourcentyps. Gültige Werte: Unternehmen CostCenter Abteilung Gruppe Standort Anwender Datentyp: Zeichenfolge

Tabelle : 92. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 93. Anforderungstext-Parameter (JSON)

Name	Beschreibung
Keine

Kopfzeilen

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 94. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/scim+json. Standard: application/json

Tabelle : 95. Antwortkopfzeilen

Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

Tabelle : 96. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
Beschreibung	Kurze Beschreibung des Ressourcentyps. Datentyp: Zeichenfolge
endpoint	Name des HTTP-adressierbaren Endpunkts relativ zur Basis-URL des Service Providers, z. B. „Unternehmen“. Datentyp: Zeichenfolge
id	Eindeutiger Bezeichner für die Ressource. Verwenden Sie dieses Attribut beim Aufrufen des Endpunkts GET /scim/ResourceType/{resource_ID}. Datentyp: Zeichenfolge
meta	Informationen, die die zugeordnete Ressource weiter beschreiben. Datentyp: Objekt "metadata": { "location": "String", "resourceType": "String" }
Meta.location	URI des zugeordneten Ressourcentyps auf dem zugeordneten ServiceNow Instanz. Datentyp: Zeichenfolge
Meta.resourceType	Immer „ResourceType“. Datentyp: Zeichenfolge
name	Name des Ressourcentyps, z. B. Anwender oder Gruppe. Datentyp: Zeichenfolge
Schema	Primärer/Basisschema-URI des Ressourcentyps. Beispiel: „URN:ietf:Parameters:scim:Schemas:Core:2,0:Anwender“ . Datentyp: Zeichenfolge
Schemas	Schema, das zum Verarbeiten von verwendet wird /ResourceType Anforderung. Beispiel: „URN:ietf:params:scim:Schemas:Core:2,0:ResourceType“ . Datentyp: Zeichenfolge
SchemaErweiterungen	Liste der Schemaerweiterungen, die für den zugehörigen Ressourcentyp gelten. Beispiel: „URN:ietf:params:scim:Schemas:Extension: servicenow:2,0:User“ . Datentyp: Array des Objekts "schemaExtensions": { "required": Boolean, "schema": "String" }
SchemaErweiterungen.erforderlich	Kennzeichnung, die angibt, ob die Schemaerweiterung für den Ressourcentyp erforderlich ist. Mögliche Werte: Wahr: Eine Ressource dieses Typs muss diese Schemaerweiterung und auch alle Attribute enthalten, die in dieser Schemaerweiterung als erforderlich deklariert sind. Falsch: Eine Ressource dieses Typs kann diese Schemaerweiterung auslassen. Datentyp: Boolesch
SchemaErweiterungen.Schema	URI eines erweiterten Schemas. Beispiel: „URN:ietf:params:scim:Schemas:Extension: servicenow:2,0:User“ . Datentyp: Zeichenfolge
Schemas	Schema, das zum Verarbeiten der Listenantwort auf die Anforderung verwendet wird. Beispiel: „URN:ietf:Parameters:scim:api:Messages:2,0:ListResponse“ Datentyp: Zeichenfolge

cURL-Anforderung

Das folgende Beispiel zeigt, wie Sie den Ressourcentyp „Anwender-SCIM“ von einem abrufen ServiceNow Instanz.

curl "https://instance-servicenow.com/api/now/scim/ResourceTypes/"User" \
--request GET \
--header "Accept:application/scim+json" \

Antwort:

{
  "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: /scim/Schemas ABRUFEN

Ruft Informationen zu allen von einem unterstützten Ressourcenschemen für System für domänenübergreifendes Identity Management (SCIM) ab ServiceNow Instanz. Diese Schemas definieren die Attribute, die für jeden Ressourcentyp verfügbar sind.

Dies ist ein öffentlicher Endpunkt und erfordert keine Rollen für den Zugriff.

URL-Format

Versionierte URL: /api/now/{api_Version}/scim/Schemas

Standard-URL: /api/now/scim/Schemas

Hinweis:

Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

Unterstützte Anforderungsparameter

Tabelle : 97. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 98. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 99. Anforderungstext-Parameter (JSON)

Name	Beschreibung
Keine

Kopfzeilen

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 100. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/scim+json. Standard: application/json

Tabelle : 101. Antwortkopfzeilen

Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

Tabelle : 102. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
Standard-RFC7643 gibt Ergebnisse zurück	Methode gibt Ergebnisse zurück, die dem RFC7643-Standard entsprechen. Weitere Informationen finden Sie unter Schemadefinition In der Spezifikation RFC7643.

cURL-Anforderung

Das folgende Beispiel zeigt, wie die von unterstützten SCIM-Schemas abgerufen werden ServiceNow Instanz.

curl "https://instance-servicenow.com/api/now/scim/Schemas \
--request GET \
--header "Accept:application/scim+json" \

Antwort:

{
  "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: /scim/Schemas/{SchemaName} ABRUFEN

Ruft Informationen zum angegebenen System für SCIM-Ressourcenschemas (System for Domain Identity Management) ab, die von unterstützt werden ServiceNow Instanz. Diese Schemas definieren die Attribute, die für jeden Ressourcentyp verfügbar sind.

Dies ist ein öffentlicher Endpunkt und erfordert keine Rollen für den Zugriff.

URL-Format

Versionierte URL: /api/now/{api_Version}/scim/Schemas/{SchemaName}

Standard-URL: /api/now/scim/Schemas/{SchemaName}

Hinweis:

Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

Unterstützte Anforderungsparameter

Tabelle : 103. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
Schemaname	URI des zurückzugebenden Ressourcenschemas. Gültige Werte: URN:ietf:params:scim:Schemas:Core:2,0:Anwender 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 Datentyp: Zeichenfolge

Tabelle : 104. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 105. Anforderungstext-Parameter (JSON)

Name	Beschreibung
Keine

Kopfzeilen

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 106. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/scim+json. Standard: application/json

Tabelle : 107. Antwortkopfzeilen

Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

Tabelle : 108. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
Standard-RFC7643 gibt Ergebnisse zurück	Methode gibt Ergebnisse zurück, die dem RFC7643-Standard entsprechen. Weitere Informationen finden Sie unter Schemadefinition In der Spezifikation RFC7643.

cURL-Anforderung

Das folgende Beispiel zeigt, wie Sie das SCIM-Schema der Kerngruppe von einem abrufen ServiceNow Instanz.

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

Antwort:

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

Gibt die Konfigurationsmetadaten zurück, die verwendet werden sollen, um Informationen zu den Servicefähigkeiten, Konfigurationen, Schemas und Ressourcentypen für die SCIM-Endpunkte (System for Domain Identity Management) abzurufen, die in verfügbar sind ServiceNow Instanz.

Dies ist ein öffentlicher Endpunkt und erfordert keine Rollen für den Zugriff.

URL-Format

Versionierte URL: /api/now/{api_Version}/scim/ServiceProviderConfig

Standard-URL: /api/now/scim/ServiceProviderConfig

Hinweis:

Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

Unterstützte Anforderungsparameter

Tabelle : 109. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 110. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 111. Anforderungstext-Parameter (JSON)

Name	Beschreibung
Keine

Kopfzeilen

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 112. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/scim+json. Standard: application/json

Tabelle : 113. Antwortkopfzeilen

Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

Tabelle : 114. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
Standard-RFC7643 gibt Ergebnisse zurück	Methode gibt Ergebnisse zurück, die dem RFC7643-Standard entsprechen. Weitere Informationen finden Sie unter Konfigurationsschema Des Service Providers In der Spezifikation RFC7643.

cURL-Anforderung

Das folgende Beispiel zeigt, wie Sie die SCIM-Konfigurationsmetadaten für einen abrufen ServiceNow Instanz.

curl "https://instance-servicenow.com/api/now/scim/ServiceProviderConfig \
--request GET \
--header "Accept:application/scim+json" \

Antwort:

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"
  ],
  "patch": {
    "supported": true
  },
  "bulk": {
    "supported": false,
    "maxOperations": 0,
    "maxPayloadSize": 1000000
  },
  "filter": {
    "supported": true,
    "maxResults": 500
  },
  "changePassword": {
    "supported": false
  },
  "sort": {
    "supported": false
  },
  "etag": {
    "supported": false
  },
  "authenticationSchemes": [
    {
      "name": "OAuth 2.0 Bearer Token",
      "description": "The OAuth 2.0 Bearer Token Authentication scheme. OAuth
        enables clients to access protected resources by obtaining an access token, which is
        defined in RFC 6750 as \"a string representing an access authorization issued to the
        client\", rather than using the resource owner's credentials directly.",
      "specUri": "http://tools.ietf.org/html/rfc6750",
      "type": "oauthbearertoken",
      "primary": true
    }
  ]
}

SCIM – GET /scim/companies

Gibt einen oder mehrere Unternehmensdatensätze aus der Tabelle „Unternehmen“ [Core_Company] in einem zurück ServiceNow Instanz, die das SCIM-Protokoll (System for Domain Identity Management) verwendet.

Hinweis:

Eine Abfrage, die keine Übereinstimmungen zurückgibt, gibt Erfolg (HTTP-Statuscode 200) mit zurück totalResultsAuf 0 festlegen.

URL-Format

Versionierte URL: /api/now/{api_Version}/scim/Companies

Standard-URL: /api/now/scim/Companies

Hinweis:

Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

Unterstützte Anforderungsparameter

Tabelle : 115. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 116. Abfrageparameter

Name	Beschreibung
Attribute	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit verwendet werden excludedAttributesParameter. Datentyp: Zeichenfolge Standard: Alle Felder zurückgeben, es sei denn excludedAttributesIst angegeben.
count	Anzahl der zurückzugebenden Datensätze. Ein negativer Wert wird als Null interpretiert. Datentyp: Zahl Maximum: 500 – Ein Wert größer als dieser führt zu einem Fehler bei einer ungültigen Anforderung. Standard: 10
Exklusive Attribute	Kommagetrennte Liste von Feldern, die aus den in der Antwort zurückgegebenen Datensätzen ausgeschlossen werden sollen. Alle anderen Felder werden zurückgegeben. Kann nicht mit verwendet werden attributesParameter. Datentyp: Zeichenfolge Standard: Schließen Sie keine Felder aus.
Filter	Filterausdruck, der auf die Rückgabeergebnisse angewendet werden soll. Feldfilter werden als ausgedrückt <field_name> <operator> <„value“> . Siehe RFC7644 Für eine Liste der gültigen Operatoren. Hinweis: Die NICHT Operator wird von dieser Methode nicht unterstützt. Um beispielsweise nach allen Unternehmen zu filtern, deren Name mit „Acme“ beginnt, geben Sie ein DisplayName SW „Acme“ . Um mehr als einen Feldfilter anzugeben, verketten Sie die Filter mit UND Operand. Um beispielsweise nach allen Unternehmen zu filtern, deren Name mit „Acme“ beginnt und zuletzt vor dem 3. Oktober 2021 geändert wurden, geben Sie ein DisplayName SW „Acme“ UND Meta.lastModified LT „2021-10-03T00:00:00Z“ . Verwenden Sie Dot-Walking, um geschachtelte Attribute anzugeben. Datentyp: Zeichenfolge Standard: Keine Filterung
sortBy	Muss mit angegeben werden sortOrderParameter. Feld, nach dem die Rückgabeergebnisse sortiert werden sollen. Beim Sortieren wird die Groß-/Kleinschreibung nicht beachtet. Sie können nur die Parameter verwenden, die zum Filtern für verfügbar sind sortByParameter, außer dem externalIdIst nicht zulässig. Für Werte, die null sind: Aufsteigend sortiert: Nullwerte werden nach oben sortiert. Sortiert nach absteigend: Nullwerte werden nach unten sortiert. Datentyp: Zeichenfolge Standard: Keine Sortierung
sortOrder	Muss mit angegeben werden sortByParameter. Reihenfolge, in der sortByParameter wird auf die Rückgabeergebnisse angewendet. Gültige Werte: Aufsteigend Absteigend Datentyp: Zeichenfolge Standard: Aufsteigend
startIndex	Einbasierter Index in der Tabelle, bei der mit dem Abrufen von Datensätzen begonnen werden soll. Wenn Sie diesen Parameter beispielsweise auf 100 festlegen, und die countParameter für 20. Der Endpunkt gibt Datensätze 100 bis 119 zurück. Hinweis: Jeder Wert, der auf weniger als eins festgelegt ist, wird als einer interpretiert. Datentyp: Zeichenfolge Standard: 1

Tabelle : 117. Anforderungstext-Parameter (JSON)

Name	Beschreibung
Keine

Kopfzeilen

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 118. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/scim+json. Standard: application/json

Tabelle : 119. Antwortkopfzeilen

Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

Tabelle : 120. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. Stellen Sie sicher, dass beide attributesUnd excludedAttributesAbfrageparameter wurden in der Anforderung nicht übergeben. Stellen Sie sicher, dass countParameter ist nicht größer als 500. Stellen Sie sicher, dass alle vorhanden sind filterParameter sind gültig.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
ItemsPerPage	Anzahl der in den Rückgabeergebnissen zurückgegebenen Datensätze. Datentyp: Zahl
Ressourcen	Liste der zurückgegebenen Kostenstellendatensätze. Datentyp: Objekt "Resources": { "id": "String", "meta": {Object}, "name": "String", "schemas": "String" }
Ressourcen.ID	SYS_ID des Unternehmensdatensatzes. Datentyp: Zeichenfolge
Ressourcen.Meta	Informationen zum Unternehmensdatensatz. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" }
Ressourcen.Meta.erstellt	Datum und Uhrzeit der Erstellung des zugehörigen Unternehmensdatensatzes. Datentyp: Zeichenfolge
Ressourcen.Meta.lastModifiziert	Datum und Uhrzeit der letzten Änderung des zugehörigen Unternehmensdatensatzes. Datentyp: Zeichenfolge
Ressourcen.Meta.Standort	URI des zugehörigen Unternehmensdatensatzes. Datentyp: Zeichenfolge
Ressourcen.Meta.resourceType	SCIM-Ressourcentyp: Immer Unternehmen. Datentyp: Zeichenfolge
Resources.name	Unternehmensname. Datentyp: Zeichenfolge
Ressourcen.Schemas	Schema, das bei der Verarbeitung der Anforderung verwendet wird. Datentyp: Zeichenfolge
Schemas	Schema, das zum Verarbeiten der Listenantwort auf die Anforderung verwendet wird. Beispiel: „URN:ietf:Parameters:scim:api:Messages:2,0:ListResponse“ Datentyp: Zeichenfolge
startIndex	Einbasierter Index in der Tabelle „Unternehmen“ [Core_Company], in der die Datensätze zurückgegeben wurden. Datentyp: Zeichenfolge
totalResults	Gesamtanzahl der Datensätze, die der Anforderung entsprechen. Datentyp: Zahl

cURL-Anforderung

Dieses Beispiel zeigt, wie die ersten beiden Unternehmensdatensätze abgerufen werden.

curl "https://instance-servicenow.com/api/now/scim/Companies?count=2" \
--request GET \
--header "Accept:application/scim+json" \

Antwort:

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

Gibt den angegebenen Unternehmensdatensatz aus der Tabelle „Unternehmen“ [Core_Company] in einem zurück ServiceNow Instanz, die das SCIM-Protokoll (System for Domain Identity Management) verwendet.

URL-Format

Versionierte URL: /api/now/{api_Version}/scim/Companies/{Company_ID}

Standard-URL: /api/now/scim/Groups/{Company_ID}

Hinweis:

Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

Unterstützte Anforderungsparameter

Tabelle : 121. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
company_id	SYS_ID des zurückzugebenden Unternehmensdatensatzes. Datentyp: Zeichenfolge

Tabelle : 122. Abfrageparameter

Name	Beschreibung
Attribute	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit verwendet werden excludedAttributesParameter. Datentyp: Zeichenfolge Standard: Alle Felder zurückgeben, es sei denn excludedAttributesIst angegeben.
Exklusive Attribute	Kommagetrennte Liste von Feldern, die aus den in der Antwort zurückgegebenen Datensätzen ausgeschlossen werden sollen. Alle anderen Felder werden zurückgegeben. Kann nicht mit verwendet werden attributesParameter. Datentyp: Zeichenfolge Standard: Schließen Sie keine Felder aus.

Tabelle : 123. Anforderungstext-Parameter (JSON)

Name	Beschreibung
Keine

Kopfzeilen

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 124. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/scim+json. Standard: application/json

Tabelle : 125. Antwortkopfzeilen

Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

Tabelle : 126. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. Stellen Sie sicher, dass beide attributesUnd excludedAttributesAbfrageparameter wurden in der Anforderung nicht übergeben. Stellen Sie sicher, dass countParameter ist nicht größer als 500. Stellen Sie sicher, dass alle vorhanden sind filterParameter sind gültig.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
id	SYS_ID des Unternehmensdatensatzes. Datentyp: Zeichenfolge
meta	Informationen zum Unternehmensdatensatz. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" }
Meta.erstellt	Datum und Uhrzeit der Erstellung des zugehörigen Unternehmensdatensatzes. Datentyp: Zeichenfolge
Meta.lastModifiziert	Datum und Uhrzeit der letzten Änderung des zugehörigen Unternehmensdatensatzes. Datentyp: Zeichenfolge
Meta.location	URI des zugehörigen Unternehmensdatensatzes. Datentyp: Zeichenfolge
Meta.resourceType	SCIM-Ressourcentyp: Immer Unternehmen. Datentyp: Zeichenfolge
name	Unternehmensname. Datentyp: Zeichenfolge
Schemas	Schema, das bei der Verarbeitung der Anforderung verwendet wird. Datentyp: Zeichenfolge

cURL-Anforderung

Dieses Beispiel zeigt, wie ein bestimmter Unternehmensdatensatz abgerufen wird.

curl "https://instance-servicenow.com/api/now/scim/Companies/0c43af40c6112275011a4bd4c0143fbf" \
--request GET \
--header "Accept:application/scim+json" \

Antwort

{
  "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: /scim/CostCenters ABRUFEN

Gibt einen oder mehrere Kostenstellendatensätze aus der Tabelle „Kostenstelle“ [cmn_Cost_Center] in einem zurück ServiceNow Instanz, die das SCIM-Protokoll (System for Domain Identity Management) verwendet.

Hinweis:

Eine Abfrage, die keine Übereinstimmungen zurückgibt, gibt Erfolg (HTTP-Statuscode 200) mit zurück totalResultsAuf 0 festlegen.

URL-Format

Versionierte URL: /api/now/{api_Version}/scim/CostCenter

Standard-URL: /api/now/scim/CostCenter

Hinweis:

Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

Unterstützte Anforderungsparameter

Tabelle : 127. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 128. Abfrageparameter

Name	Beschreibung
Attribute	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit verwendet werden excludedAttributesParameter. Datentyp: Zeichenfolge Standard: Alle Felder zurückgeben, es sei denn excludedAttributesIst angegeben.
count	Anzahl der zurückzugebenden Datensätze. Ein negativer Wert wird als Null interpretiert. Datentyp: Zahl Maximum: 500 – Ein Wert größer als dieser führt zu einem Fehler bei einer ungültigen Anforderung. Standard: 10
Exklusive Attribute	Kommagetrennte Liste von Feldern, die aus den in der Antwort zurückgegebenen Datensätzen ausgeschlossen werden sollen. Alle anderen Felder werden zurückgegeben. Kann nicht mit verwendet werden attributesParameter. Datentyp: Zeichenfolge Standard: Schließen Sie keine Felder aus.
Filter	Filterausdruck, der auf die Rückgabeergebnisse angewendet werden soll. Feldfilter werden als ausgedrückt <field_name> <operator> <„value“> . Siehe RFC7644 Für eine Liste der gültigen Operatoren. Hinweis: Die NICHT Operator wird von dieser Methode nicht unterstützt. Um beispielsweise nach allen Kostenstellen zu filtern, deren Name mit „HR“ beginnt, geben Sie ein DisplayName SW „HR“ . Um mehr als einen Feldfilter anzugeben, verketten Sie die Filter mit UND Operand. Um beispielsweise nach allen Kostenstellen zu filtern, deren Name mit „HR“ beginnt und zuletzt vor dem 3. Oktober 2021 geändert wurden, geben Sie ein DisplayName SW „HR“ UND Meta.lastModified LT „2021-10-03T00:00:00Z“ . Verwenden Sie Dot-Walking, um geschachtelte Attribute anzugeben. Datentyp: Zeichenfolge Standard: Keine Filterung
sortBy	Muss mit angegeben werden sortOrderParameter. Feld, nach dem die Rückgabeergebnisse sortiert werden sollen. Beim Sortieren wird die Groß-/Kleinschreibung nicht beachtet. Sie können nur die Parameter verwenden, die zum Filtern für verfügbar sind sortByParameter, außer dem externalIdIst nicht zulässig. Für Werte, die null sind: Aufsteigend sortiert: Nullwerte werden nach oben sortiert. Sortiert nach absteigend: Nullwerte werden nach unten sortiert. Datentyp: Zeichenfolge Standard: Keine Sortierung
sortOrder	Muss mit angegeben werden sortByParameter. Reihenfolge, in der sortByParameter wird auf die Rückgabeergebnisse angewendet. Gültige Werte: Aufsteigend Absteigend Datentyp: Zeichenfolge Standard: Aufsteigend
startIndex	Einbasierter Index in der Tabelle, bei der mit dem Abrufen von Datensätzen begonnen werden soll. Wenn Sie diesen Parameter beispielsweise auf 100 festlegen, und die countParameter für 20. Der Endpunkt gibt Datensätze 100 bis 119 zurück. Hinweis: Jeder Wert, der auf weniger als eins festgelegt ist, wird als einer interpretiert. Datentyp: Zeichenfolge Standard: 1

Tabelle : 129. Anforderungstext-Parameter (SON)

Name	Beschreibung
Keine

Header

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 130. Anforderungskopfzeilen.

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/scim+json. Standard: application/json

Tabelle : 131. Antwortkopfzeilen

Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

Tabelle : 132. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. Stellen Sie sicher, dass beide attributesUnd excludedAttributesAbfrageparameter wurden in der Anforderung nicht übergeben. Stellen Sie sicher, dass countParameter ist nicht größer als 500. Stellen Sie sicher, dass alle vorhanden sind filterParameter sind gültig.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
ItemsPerPage	Anzahl der in den Rückgabeergebnissen zurückgegebenen Datensätze. Datentyp: Zahl
Ressourcen	Liste der zurückgegebenen Kostenstellendatensätze. Datentyp: Objekt "Resources": { "id": "String", "meta": {Object}, "name": "String", "schemas": "String" }
Ressourcen.ID	SYS_ID des Kostenstellendatensatzes. Datentyp: Zeichenfolge
Ressourcen.Meta	Informationen zum Kostenstellendatensatz. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" }
Ressourcen.Meta.erstellt	Datum und Uhrzeit der Erstellung des zugehörigen Kostenstellendatensatzes. Datentyp: Zeichenfolge
Ressourcen.Meta.lastModifiziert	Datum und Uhrzeit der letzten Änderung des zugehörigen Kostenstellendatensatzes. Datentyp: Zeichenfolge
Ressourcen.Meta.Standort	URI des zugehörigen Kostenstellendatensatzes. Datentyp: Zeichenfolge
Ressourcen.Meta.resourceType	SCIM-Ressourcentyp: Immer CostCenter. Datentyp: Zeichenfolge
Resources.name	Name der Kostenstelle. Datentyp: Zeichenfolge
Ressourcen.Schemas	Schema, das bei der Verarbeitung der Anforderung verwendet wird. Datentyp: Zeichenfolge
Schemas	Schema, das zum Verarbeiten der Listenantwort auf die Anforderung verwendet wird. Beispiel: „URN:ietf:Parameters:scim:api:Messages:2,0:ListResponse“ Datentyp: Zeichenfolge
startIndex	Einbasierter Index in der Tabelle „Kostenstelle“ [cmn_Cost_Center], in der die Datensätze zurückgegeben wurden. Datentyp: Zeichenfolge
totalResults	Gesamtanzahl der Datensätze, die der Anforderung entsprechen. Datentyp: Zahl

cURL-Anforderung

Dieses Beispiel zeigt, wie die ersten beiden Kostenstellendatensätze abgerufen werden.

curl "https://instance-servicenow.com/api/now/scim/CostCenters?count=2" \
--request GET \
--header "Accept:application/scim+json" \

Antwort:

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

Gibt den angegebenen Kostenstellendatensatz aus der Tabelle „Kostenstelle“ [cmn_Cost_Center] in einem zurück ServiceNow Instanz, die das SCIM-Protokoll (System for Domain Identity Management) verwendet.

Hinweis:

Eine Abfrage, die keine Übereinstimmungen zurückgibt, gibt Erfolg (HTTP-Statuscode 200) mit zurück totalResultsAuf 0 festlegen.

URL-Format

Versionierte URL: /api/now/{api_Version}/scim/CostCenter/{Cost_Center_ID}

Standard-URL: /api/now/scim/CoostCenters/{Cost_Center_ID}

Hinweis:

Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

Unterstützte Anforderungsparameter

Tabelle : 133. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
Cost_Center_ID	SYS_ID des zurückzugebenden Kostenstellendatensatzes. Datentyp: Zeichenfolge

Tabelle : 134. Abfrageparameter

Name	Beschreibung
Attribute	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit verwendet werden excludedAttributesParameter. Datentyp: Zeichenfolge Standard: Alle Felder zurückgeben, es sei denn excludedAttributesIst angegeben.
Exklusive Attribute	Kommagetrennte Liste von Feldern, die aus den in der Antwort zurückgegebenen Datensätzen ausgeschlossen werden sollen. Alle anderen Felder werden zurückgegeben. Kann nicht mit verwendet werden attributesParameter. Datentyp: Zeichenfolge Standard: Schließen Sie keine Felder aus.

Tabelle : 135. Anforderungstext-Parameter (JSON)

Name	Beschreibung
Keine

Kopfzeilen

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 136. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/scim+json. Standard: application/json

Tabelle : 137. Antwortkopfzeilen

Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

Tabelle : 138. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. Stellen Sie sicher, dass beide attributesUnd excludedAttributesAbfrageparameter wurden in der Anforderung nicht übergeben. Stellen Sie sicher, dass countParameter ist nicht größer als 500. Stellen Sie sicher, dass alle vorhanden sind filterParameter sind gültig.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
id	SYS_ID des Kostenstellendatensatzes. Datentyp: Zeichenfolge
meta	Informationen zum Kostenstellendatensatz. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" }
Meta.erstellt	Datum und Uhrzeit der Erstellung des zugehörigen Kostenstellendatensatzes. Datentyp: Zeichenfolge
Meta.lastModifiziert	Datum und Uhrzeit der letzten Änderung des zugehörigen Kostenstellendatensatzes. Datentyp: Zeichenfolge
Meta.location	URI des zugehörigen Kostenstellendatensatzes. Datentyp: Zeichenfolge
Meta.resourceType	SCIM-Ressourcentyp: Immer CostCenter. Datentyp: Zeichenfolge
name	Name der Kostenstelle. Datentyp: Zeichenfolge
Schemas	Schema, das bei der Verarbeitung der Anforderung verwendet wird. Datentyp: Zeichenfolge

cURL-Anforderung

Dieses Beispiel zeigt, wie ein bestimmter Kostenstellendatensatz abgerufen wird.

curl "https://instance-servicenow.com/api/now/scim/CostCenters/7fb1cc99c0a80a6d30c04574d14c0acf" \
--request GET \
--header "Accept:application/scim+json" \

Antwort:

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

Gibt einen oder mehrere Abteilungsdatensätze aus der Tabelle „Abteilung“ [cmn_Department] in einem zurück ServiceNow Instanz, die das SCIM-Protokoll (System for Domain Identity Management) verwendet.

Hinweis:

Eine Abfrage, die keine Übereinstimmungen zurückgibt, gibt Erfolg (HTTP-Statuscode 200) mit zurück totalResultsAuf 0 festlegen.

URL-Format

Versionierte URL: /api/now/{api_Version}/scim/Departments

Standard-URL: /api/now/scim/Departments

Hinweis:

Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

Unterstützte Anforderungsparameter

Tabelle : 139. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 140. Abfrageparameter

Name	Beschreibung
Attribute	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit verwendet werden excludedAttributesParameter. Datentyp: Zeichenfolge Standard: Alle Felder zurückgeben, es sei denn excludedAttributesIst angegeben.
count	Anzahl der zurückzugebenden Datensätze. Ein negativer Wert wird als Null interpretiert. Datentyp: Zahl Maximum: 500 – Ein Wert größer als dieser führt zu einem Fehler bei einer ungültigen Anforderung. Standard: 10
Exklusive Attribute	Kommagetrennte Liste von Feldern, die aus den in der Antwort zurückgegebenen Datensätzen ausgeschlossen werden sollen. Alle anderen Felder werden zurückgegeben. Kann nicht mit verwendet werden attributesParameter. Datentyp: Zeichenfolge Standard: Schließen Sie keine Felder aus.
Filter	Filterausdruck, der auf die Rückgabeergebnisse angewendet werden soll. Feldfilter werden als ausgedrückt <field_name> <operator> <„value“> . Siehe RFC7644 Für eine Liste der gültigen Operatoren. Hinweis: Die NICHT Operator wird von dieser Methode nicht unterstützt. Um beispielsweise nach allen Abteilungen zu filtern, deren Name mit „Ingenieur“ beginnt, geben Sie ein DisplayName SW „Ingenieur“ . Um mehr als einen Feldfilter anzugeben, verketten Sie die Filter mit UND Operand. Um beispielsweise nach allen Abteilungen zu filtern, deren Name mit „Ingenieur“ beginnt und zuletzt vor dem 3. Oktober 2021 geändert wurden, geben Sie ein DisplayName SW „Engineer“ UND Meta.lastModified LT „2021-10-03T00:00:00Z“ . Verwenden Sie Dot-Walking, um geschachtelte Attribute anzugeben. Datentyp: Zeichenfolge Standard: Keine Filterung
sortBy	Muss mit angegeben werden sortOrderParameter. Feld, nach dem die Rückgabeergebnisse sortiert werden sollen. Beim Sortieren wird die Groß-/Kleinschreibung nicht beachtet. Sie können nur die Parameter verwenden, die zum Filtern für verfügbar sind sortByParameter, außer dem externalIdIst nicht zulässig. Für Werte, die null sind: Aufsteigend sortiert: Nullwerte werden nach oben sortiert. Sortiert nach absteigend: Nullwerte werden nach unten sortiert. Datentyp: Zeichenfolge Standard: Keine Sortierung
sortOrder	Muss mit angegeben werden sortByParameter. Reihenfolge, in der sortByParameter wird auf die Rückgabeergebnisse angewendet. Gültige Werte: Aufsteigend Absteigend Datentyp: Zeichenfolge Standard: Aufsteigend
startIndex	Einbasierter Index in der Tabelle, bei der mit dem Abrufen von Datensätzen begonnen werden soll. Wenn Sie diesen Parameter beispielsweise auf 100 festlegen, und die countParameter für 20. Der Endpunkt gibt Datensätze 100 bis 119 zurück. Hinweis: Jeder Wert, der auf weniger als eins festgelegt ist, wird als einer interpretiert. Datentyp: Zeichenfolge Standard: 1

Tabelle : 141. Anforderungstext-Parameter (JSON)

Name	Beschreibung
Keine

Kopfzeilen

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 142. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/scim+json. Standard: application/json

Tabelle : 143. Antwortkopfzeilen

Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

Tabelle : 144. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. Stellen Sie sicher, dass beide attributesUnd excludedAttributesAbfrageparameter wurden in der Anforderung nicht übergeben. Stellen Sie sicher, dass countParameter ist nicht größer als 500. Stellen Sie sicher, dass alle vorhanden sind filterParameter sind gültig.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
ItemsPerPage	Anzahl der in den Rückgabeergebnissen zurückgegebenen Datensätze. Datentyp: Zahl
Ressourcen	Liste der zurückgegebenen Abteilungsdatensätze. Datentyp: Objekt "Resources": { "id": "String", "meta": {Object}, "name": "String", "schemas": "String" }
Ressourcen.ID	SYS_ID des Abteilungsdatensatzes. Datentyp: Zeichenfolge
Ressourcen.Meta	Informationen zum Abteilungsdatensatz. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" }
Ressourcen.Meta.erstellt	Datum und Uhrzeit der Erstellung des zugehörigen Abteilungsdatensatzes. Datentyp: Zeichenfolge
Ressourcen.Meta.lastModifiziert	Datum und Uhrzeit der letzten Änderung des zugehörigen Abteilungsdatensatzes. Datentyp: Zeichenfolge
Ressourcen.Meta.Standort	URI des zugehörigen Abteilungsdatensatzes. Datentyp: Zeichenfolge
Ressourcen.Meta.resourceType	SCIM-Ressourcentyp: Immer Abteilung. Datentyp: Zeichenfolge
Resources.name	Abteilungsname. Datentyp: Zeichenfolge
Ressourcen.Schemas
Schemas
startIndex	Einbasierter Index in der Tabelle „Abteilung“ [cmn_Department], in der die Datensätze zurückgegeben wurden. Datentyp: Zeichenfolge
totalResults	Gesamtanzahl der Datensätze, die der Anforderung entsprechen. Datentyp: Zahl

cURL-Anforderung

Dieses Beispiel zeigt, wie die ersten beiden Abteilungsdatensätze abgerufen werden.

curl "https://instance-servicenow.com/api/now/scim/Departments?count=2" \
--request GET \
--header "Accept:application/scim+json" \

Antwort:

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

Gibt den angegebenen Abteilungsdatensatz aus der Tabelle „Abteilung“ [cmn_Department] in einem zurück ServiceNow Instanz, die das SCIM-Protokoll (System for Domain Identity Management) verwendet.

URL-Format

Versionierte URL: /api/now/{api_Version}/scim/Departments/{Department_ID}

Standard-URL: /api/now/scim/departments/{Department_ID}

Hinweis:

Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

Unterstützte Anforderungsparameter

Tabelle : 145. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
Abteilung_ID	SYS_ID des zurückzugebenden Abteilungsdatensatzes. Datentyp: Zeichenfolge

Tabelle : 146. Abfrageparameter

Name	Beschreibung
Attribute	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit verwendet werden excludedAttributesParameter. Datentyp: Zeichenfolge Standard: Alle Felder zurückgeben, es sei denn excludedAttributesIst angegeben.
Exklusive Attribute	Kommagetrennte Liste von Feldern, die aus den in der Antwort zurückgegebenen Datensätzen ausgeschlossen werden sollen. Alle anderen Felder werden zurückgegeben. Kann nicht mit verwendet werden attributesParameter. Datentyp: Zeichenfolge Standard: Schließen Sie keine Felder aus.

Tabelle : 147. Anforderungstext-Parameter (JSON)

Name	Beschreibung
Keine

Kopfzeilen

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 148. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/scim+json. Standard: application/json

Tabelle : 149. Antwortkopfzeilen

Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

Tabelle : 150. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. Stellen Sie sicher, dass beide attributesUnd excludedAttributesAbfrageparameter wurden in der Anforderung nicht übergeben. Stellen Sie sicher, dass countParameter ist nicht größer als 500. Stellen Sie sicher, dass alle vorhanden sind filterParameter sind gültig.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
id	SYS_ID des Abteilungsdatensatzes. Datentyp: Zeichenfolge
meta	Informationen zum Abteilungsdatensatz. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" }
Meta.erstellt	Datum und Uhrzeit der Erstellung des zugehörigen Abteilungsdatensatzes. Datentyp: Zeichenfolge
Meta.lastModifiziert	Datum und Uhrzeit der letzten Änderung des zugehörigen Abteilungsdatensatzes. Datentyp: Zeichenfolge
Meta.location	URI des zugehörigen Abteilungsdatensatzes. Datentyp: Zeichenfolge
Meta.resourceType	SCIM-Ressourcentyp: Immer Abteilung. Datentyp: Zeichenfolge
name	Abteilungsname. Datentyp: Zeichenfolge
Schemas	Schema, das bei der Verarbeitung der Anforderung verwendet wird. Datentyp: Zeichenfolge

cURL-Anforderung

Dieses Beispiel zeigt, wie ein bestimmter Abteilungsdatensatz abgerufen wird.

curl "https://instance-servicenow.com/api/now/scim/Departments/221db0edc611228401760aec06c9d929" \
--request GET \
--header "Accept:application/scim+json" \

Antwort:

{
  "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: /scim/locations ABRUFEN

Gibt einen oder mehrere Standortdatensätze aus der Tabelle „Standort“ [cmn_location] in einem zurück ServiceNow Instanz, die das SCIM-Protokoll (System for Domain Identity Management) verwendet.

Hinweis:

Eine Abfrage, die keine Übereinstimmungen zurückgibt, gibt Erfolg (HTTP-Statuscode 200) mit zurück totalResultsAuf 0 festlegen.

URL-Format

Versionierte URL: /api/now/{api_Version}/scim/locations

Standard-URL: /api/now/scim/locations

Hinweis:

Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

Unterstützte Anforderungsparameter

Tabelle : 151. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 152. Abfrageparameter

Name	Beschreibung
Attribute	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit verwendet werden excludedAttributesParameter. Datentyp: Zeichenfolge Standard: Alle Felder zurückgeben, es sei denn excludedAttributesIst angegeben.
count	Anzahl der zurückzugebenden Datensätze. Ein negativer Wert wird als Null interpretiert. Datentyp: Zahl Maximum: 500 – Ein Wert größer als dieser führt zu einem Fehler bei einer ungültigen Anforderung. Standard: 10
Exklusive Attribute	Kommagetrennte Liste von Feldern, die aus den in der Antwort zurückgegebenen Datensätzen ausgeschlossen werden sollen. Alle anderen Felder werden zurückgegeben. Kann nicht mit verwendet werden attributesParameter. Datentyp: Zeichenfolge Standard: Schließen Sie keine Felder aus.
Filter	Filterausdruck, der auf die Rückgabeergebnisse angewendet werden soll. Feldfilter werden als ausgedrückt <field_name> <operator> <„value“> . Siehe RFC7644 Für eine Liste der gültigen Operatoren. Hinweis: Die NICHT Operator wird von dieser Methode nicht unterstützt. Um beispielsweise nach allen Standorten zu filtern, deren Name mit „CH“ beginnt, geben Sie ein DisplayName SW „CH“ . Um mehr als einen Feldfilter anzugeben, verketten Sie die Filter mit UND Operand. Um beispielsweise nach allen Standorten zu filtern, deren Name mit „CH“ beginnt und zuletzt vor dem 3. Oktober 2021 geändert wurden, geben Sie ein DisplayName SW „CH“ UND Meta.lastModified LT „2021-10-03T00:00:00Z“ . Verwenden Sie Dot-Walking, um geschachtelte Attribute anzugeben. Datentyp: Zeichenfolge Standard: Keine Filterung
sortBy	Muss mit angegeben werden sortOrderParameter. Feld, nach dem die Rückgabeergebnisse sortiert werden sollen. Beim Sortieren wird die Groß-/Kleinschreibung nicht beachtet. Sie können nur die Parameter verwenden, die zum Filtern für verfügbar sind sortByParameter, außer dem externalIdIst nicht zulässig. Für Werte, die null sind: Aufsteigend sortiert: Nullwerte werden nach oben sortiert. Sortiert nach absteigend: Nullwerte werden nach unten sortiert. Datentyp: Zeichenfolge Standard: Keine Sortierung
sortOrder	Muss mit angegeben werden sortByParameter. Reihenfolge, in der sortByParameter wird auf die Rückgabeergebnisse angewendet. Gültige Werte: Aufsteigend Absteigend Datentyp: Zeichenfolge Standard: Aufsteigend
startIndex	Einbasierter Index in der Tabelle, bei der mit dem Abrufen von Datensätzen begonnen werden soll. Wenn Sie diesen Parameter beispielsweise auf 100 festlegen, und die countParameter für 20. Der Endpunkt gibt Datensätze 100 bis 119 zurück. Hinweis: Jeder Wert, der auf weniger als eins festgelegt ist, wird als einer interpretiert. Datentyp: Zeichenfolge Standard: 1

Tabelle : 153. Anforderungstext-Parameter (JSON)

Name	Beschreibung
Keine

Kopfzeilen

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 154. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/scim+json. Standard: application/json

Tabelle : 155. Antwortkopfzeilen

Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

Tabelle : 156. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. Stellen Sie sicher, dass beide attributesUnd excludedAttributesAbfrageparameter wurden in der Anforderung nicht übergeben. Stellen Sie sicher, dass countParameter ist nicht größer als 500. Stellen Sie sicher, dass alle vorhanden sind filterParameter sind gültig.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
ItemsPerPage	Anzahl der in den Rückgabeergebnissen zurückgegebenen Datensätze. Datentyp: Zahl
Ressourcen	Liste der zurückgegebenen Standortdatensätze. Datentyp: Objekt "Resources": { "id": "String", "meta": {Object}, "name": "String", "schemas": "String" }
Ressourcen.ID	SYS_ID des Standortdatensatzes. Datentyp: Zeichenfolge
Ressourcen.Meta	Informationen zum Standortdatensatz. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": "String", "resourceType": "String" }
Ressourcen.Meta.erstellt	Datum und Uhrzeit der Erstellung des zugehörigen Standortdatensatzes. Datentyp: Zeichenfolge
Ressourcen.Meta.lastModifiziert	Datum und Uhrzeit der letzten Änderung des zugehörigen Standortdatensatzes. Datentyp: Zeichenfolge
Ressourcen.Meta.Standort	URI des zugehörigen Standortdatensatzes. Datentyp: Zeichenfolge
Ressourcen.Meta.resourceType	SCIM-Ressourcentyp: Immer Standort. Datentyp: Zeichenfolge
Resources.name	Standortname. Datentyp: Zeichenfolge
Ressourcen.Schemas	Schema, das bei der Verarbeitung der Anforderung verwendet wird. Datentyp: Zeichenfolge
Schemas	Schema, das zum Verarbeiten der Listenantwort auf die Anforderung verwendet wird. Beispiel: „URN:ietf:Parameters:scim:api:Messages:2,0:ListResponse“ Datentyp: Zeichenfolge
startIndex	Einbasierter Index in der Tabelle „Standort“ [cmn_location], an dem die Datensätze zurückgegeben wurden. Datentyp: Zeichenfolge
totalResults	Gesamtanzahl der Datensätze, die der Anforderung entsprechen. Datentyp: Zahl

cURL-Anforderung

Dieses Beispiel zeigt, wie die ersten beiden Unternehmensdatensätze abgerufen werden.

curl "https://instance-servicenow.com/api/now/scim/Locations?count=2" \
--request GET \
--header "Accept:application/scim+json" \

Antwort

{
  "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: /scim/locations/{location_ID} ABRUFEN

Gibt den angegebenen Standortdatensatz aus der Tabelle „Standort“ [cmn_location] in einem zurück ServiceNow Instanz, die das SCIM-Protokoll (System for Domain Identity Management) verwendet.

URL-Format

Versionierte URL: /api/now/{api_Version}/scim/Locations/{location_ID}

Standard-URL: /api/now/scim/locations/{location_ID}

Hinweis:

Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

Unterstützte Anforderungsparameter

Tabelle : 157. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
location_id	SYS_ID des zurückzugebenden Standortdatensatzes. Datentyp: Zeichenfolge

Tabelle : 158. Abfrageparameter

Name	Beschreibung
Attribute	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit verwendet werden excludedAttributesParameter. Datentyp: Zeichenfolge Standard: Alle Felder zurückgeben, es sei denn excludedAttributesIst angegeben.
Exklusive Attribute	Kommagetrennte Liste von Feldern, die aus den in der Antwort zurückgegebenen Datensätzen ausgeschlossen werden sollen. Alle anderen Felder werden zurückgegeben. Kann nicht mit verwendet werden attributesParameter. Datentyp: Zeichenfolge Standard: Schließen Sie keine Felder aus.

Tabelle : 159. Anforderungstext-Parameter (JSON)

Name	Beschreibung
Keine

Kopfzeilen

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

Tabelle : 160. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/scim+json. Standard: application/json

Tabelle : 161. Antwortkopfzeilen

Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

Tabelle : 162. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. Stellen Sie sicher, dass beide attributesUnd excludedAttributesAbfrageparameter wurden in der Anforderung nicht übergeben. Stellen Sie sicher, dass countParameter ist nicht größer als 500. Stellen Sie sicher, dass alle vorhanden sind filterParameter sind gültig.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
id	SYS_ID des Standortdatensatzes. Datentyp: Zeichenfolge
meta	Informationen zum Standortdatensatz. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": "String", "resourceType": "String" }
Meta.erstellt	Datum und Uhrzeit der Erstellung des zugehörigen Standortdatensatzes. Datentyp: Zeichenfolge
Meta.lastModifiziert	Datum und Uhrzeit der letzten Änderung des zugehörigen Standortdatensatzes. Datentyp: Zeichenfolge
Meta.location	URI des zugehörigen Standortdatensatzes. Datentyp: Zeichenfolge
Meta.resourceType	SCIM-Ressourcentyp: Immer Standort. Datentyp: Zeichenfolge
name	Standortname. Datentyp: Zeichenfolge
Schemas	Schema, das bei der Verarbeitung der Anforderung verwendet wird. Datentyp: Zeichenfolge

cURL-Anforderung

Dieses Beispiel zeigt, wie ein bestimmter Standortdatensatz abgerufen wird.

curl "https://instance-servicenow.com/api/now/scim/Locations/0c43af40c6112275011a4bd4c0143fbf" \
--request GET \
--header "Accept:application/scim+json" \

Antwort:

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