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

Die SCIM-API (System for Cross-Domain Identity Management) bietet Endpunkte zum Erstellen, Lesen, Aktualisieren und Löschen von Vorgängen für Benutzer und Gruppen mithilfe des SCIM-Protokolls.

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

Um auf diese API zuzugreifen, müssen Sie das Plugin „SCIM v2 – ServiceNow® Cross-domain Identity Management“ (com.snc.integration.scim2) aktivieren.

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 werden den entsprechenden Feldern in einer vorhandenen Tabelle ServiceNow zugeordnet. In den folgenden Tabellen werden diese Zuordnungen definiert. Attribute, die keinen Feldern in vorhandenen ServiceNow Tabellen entsprechen, werden zwei SCIM-spezifischen Tabellen zugeordnet. Weitere Informationen zu diesen Tabellen finden Sie unter SCIM-spezifische Tabellen.

Die SCIM-Benutzerressource verfügt sowohl über Kernschemata (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 Kern- und Erweiterungsschemaattribute des Benutzers werden der Benutzertabelle [sys_user] zugeordnet.

Tabelle : 1. Zuordnung von Benutzerressource zu Benutzertabelle [sys_user].

SCIM-Attributname	Benutzerfeldname
aktiv	aktiv
adressen.land	country
address.default.country	country
address.home.country	country
adressen.ort	city
adressen.default.localität	city
adressen.home.localität	city
adressen.postalCode	Postleitzahl
adressen.default.postalCode	Postleitzahl
adressen.home.postalCode	Postleitzahl
adressen.region	Status
address.default.region	Status
adressen.home.region	Status
adressen.straßeAdresse	Straße
adressen.default.streetAddress	Straße
adressen.home.streetAddress	Straße
displayName	Name
emails.value	E-Mail
emails.default.value	E-Mail
emails.work.value	E-Mail
id	sys_id
meta.created	sys_created_on
meta.lastModified	sys_updated_on
name.familiename	last_name
name.givenName	first_name
name.honorificPrefix	Einführung
name.middleName	Middle_name
phoneNumbers.value	Telefon
phoneNumbers.home.value	home_phone
phoneNumbers.mobile.value	mobile_phone
phoneNumbers.work.value	Telefon
bevorzugteSprache	preferred_language
Feld	time_zone
Titel	Titel
userName	user_name

Tabelle : 2. Zuordnung von Benutzerressource zu Sys-Scim-Benutzertabelle [sys_scim_user].

SCIM-Attributname	Sys-Scim-Benutzerfeldname
externe ID	external_id

Das erweiterte SCIM-Benutzerschema (urn:ietf:params:scim:schemas:extension:servicenow:2.0:User) wird der Benutzertabelle [sys_user] zugeordnet.

Tabelle : 3. Vom Benutzer erweiterte Ressource zur Benutzertabellenzuordnung [sys_user].

SCIM-Attributname	Benutzerfeldname
unternehmen.name	unternehmen.name
unternehmen.wert	unternehmen.sys_id
costCenter.name	cost_center.name
costCenter.value	cost_center.sys_id
abteilung.name	abteilung.name
abteilung.wert	abteilung.sys_id
employeeNumber	employee_number
Geschlecht	Geschlecht
location.name	location.name
location.value	location.sys_id
manager.anzeigename	manager.name
manager.value	manager.sys_id

Das SCIM-Gruppenressourcenschema (urn:ietf:params:scim:schemas:core:2.0:Group) wird der Gruppentabelle [sys_user_group] zugeordnet.

Tabelle : 4. Zuordnung von Gruppenressource zu Gruppe [sys_user_group].

SCIM-Attributname	Gruppenfeldname
displayName	Name
id	sys_id
meta.created	sys_created_on
meta.lastModified	sys_updated_on

Der Parameter SCIM-Gruppe externalId ist der Tabelle „Sys-Scim-Gruppe“ [sys_scim_group] zugeordnet.

Tabelle : 5. Zuordnung von Gruppenressource zu Sys-Scim-Gruppentabelle [sys_scim_group].

SCIM-Attributname	Feldname der Sys-Scim-Gruppe
externe ID	external_id

Das Erweiterungsschema der SCIM-Gruppe ServiceNow (urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group) wird der Gruppentabelle [sys_user_group] zugeordnet.

Tabelle : 6. Zuordnung von Gruppenressource zu Gruppe [sys_user_group].

SCIM-Attributname	Gruppenfeldname
unternehmen.wert	unternehmen.sys_id
unternehmen.name	unternehmen.name

Das SCIM-Ressourcenschema „Unternehmen“ (urn:ietf:params:scim:schemas:custom:servicenow:2.0:Company) wird der Tabelle „Unternehmen“ [core_company] zugeordnet.

Tabelle : 7. Zuordnung von Unternehmensressource zu Tabelle „Unternehmen“ [core_company].

SCIM-Attributname	Feldname des Unternehmens
id	sys_id
meta.created	sys_created_on
meta.lastModified	sys_updated_on
Name	Name

Das SCIM-Ressourcenschema „CostCenter“ (urn:ietf:params:scim:schemas:custom:servicenow:2.0:CostCenter) wird der Tabelle „Kostenstelle“ [cmn_cost_center] zugeordnet.

Tabelle : 8. Zuordnung von CostCenter-Ressource zur Tabelle „Kostenstelle“ [cmn_cost_center].

SCIM-Attributname	Name des Felds „Kostenstelle“.
id	sys_id
meta.created	sys_created_on
meta.lastModified	sys_updated_on
Name	Name

Das SCIM-Ressourcenschema „Abteilung“ (urn:ietf:params:scim:schemas:custom:servicenow:2.0:Department) wird der Tabelle „Abteilung“ [cmn_department] zugeordnet.

Tabelle : 9. Zuordnung von Abteilungsressource zu Abteilungstabelle [cmn_department].

SCIM-Attributname	Feldname „Abteilung“.
id	sys_id
meta.created	sys_created_on
meta.lastModified	sys_updated_on
Name	Name

Das SCIM-Standortressourcenschema (urn:ietf:params:scim:schemas:custom:servicenow:2.0:Location) wird der Standorttabelle [cmn_location] zugeordnet.

Tabelle : 10. Zuordnung von Standortressource zu Standorttabelle [cmn_location].

SCIM-Attributname	Standortfeldname
id	sys_id
meta.created	sys_created_on
meta.lastModified	sys_updated_on
Name	Name

SCIM-spezifische Tabellen

Zwei Tabellen, „Sys-Scim-Benutzer“ [sys_scim_user] und „Sys-Scim-Gruppe“ [sys_scim_group], enthalten die SCIM-Attribute, die nicht vorhandenen Tabellen ServiceNow zugeordnet sind. 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 zugeordneten 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 Benutzerdatensatz erstellt hat, um auf den Benutzer in ihrem System zu verweisen. Datentyp: Zeichenfolge Maximale Länge: 255
Sys-ID	Eindeutiger Identifier für den Datensatz innerhalb einer ServiceNow -Instanz. Datentyp: Zeichenfolge Maximale Länge: 32
Aktualisiert	Datum und Uhrzeit der letzten Aktualisierung des zugeordneten Datensatzes. Datentyp: Zeichenfolge Maximale Länge: 40
Aktualisiert von	Name der Entität, die den zugeordneten Datensatz zuletzt aktualisiert hat. Datentyp: Zeichenfolge Maximale Länge: 40
Updates	Anzahl der Aktualisierungen des Datensatzes. Datentyp: Ganzzahl Maximale Länge: 40
Benutzer	Verweis auf den Benutzer, der diesem Datensatz zugeordnet ist Referenz: Benutzertabelle [sys_user]. Maximale Länge: 32
Benutzertyp	Typ des Benutzerdatensatzes. Dieser Wert wird verwendet, um die Beziehung zwischen Organisation und Benutzer zu identifizieren. Dies kann ein beliebiger Wert sein, aber typische Werte können 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 zugeordneten 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 Identifier für den Datensatz innerhalb einer ServiceNow -Instanz. Datentyp: Zeichenfolge Maximale Länge: 32
Aktualisiert	Datum und Uhrzeit der letzten Aktualisierung des zugeordneten Datensatzes. Datentyp: Zeichenfolge Maximale Länge: 40
Aktualisiert von	Name der Entität, die den zugeordneten Datensatz zuletzt aktualisiert hat. Datentyp: Zeichenfolge Maximale Länge: 40
Updates	Anzahl der Aktualisierungen des Datensatzes. Datentyp: Ganzzahl Maximale Länge: 40

Rollen und Zugriffssteuerungslisten

Die Rolle scim_admin ist für den Zugriff auf die SCIM-spezifischen Tabellen und die privaten SCIM-Endpunkte erforderlich und ermöglicht den Zugriff auf die Tabellen „Benutzer“ [sys_user] und „Gruppe“ [sys_user_group].

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

SCIM – DELETE /scim/Groups/{group_id}

Löscht den angegebenen Gruppendatensatz aus der Gruppentabelle [sys_user_group] einer Instanz ServiceNow mithilfe des SCIM-Protokolls (System for Cross-Domain Identity Management).

URL-Format

Versionierte URL: /api/now/{api_version}/scim/Groups/{group_id}

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

Unterstützte Anforderungsparameter

Tabelle : 13. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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 : 14. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 15. Anforderungstextparameter (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/json oder 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 HTTP-Antwortcodesder REST-API.

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" }
Fehler.detail	Detaillierte Fehlermeldung, warum die Anforderung fehlgeschlagen ist. Datentyp: Zeichenfolge
Fehler.scimType	SCIM-Fehlerdetail-Schlüsselwort. Datentyp: Zeichenfolge
Fehler.Schemata	URI der SCIM-Schemata, 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 Gruppentabelle [sys_user_group] gelöscht wird.

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

SCIM – GET /scim/Groups

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

Hinweis:

Eine Abfrage, die keine Übereinstimmungen zurückgibt, gibt „Success“ (HTTP-Statuscode 200) zurück, wobei totalResults auf 0 festgelegt ist.

URL-Format

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

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

Unterstützte Anforderungsparameter

Tabelle : 19. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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
attributes	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit dem Parameter excludedAttributes verwendet werden. Datentyp: Zeichenfolge Standard: Gibt alle Felder zurück, es sei denn, excludedAttributes ist angegeben.
count	Anzahl der zurückzugebenden Datensätze. Ein negativer Wert wird als Null interpretiert. Datentyp: Zahl Maximum: 500 – Ein größerer Wert führt zu einem Fehler bei der Anforderung. Standard: 10
ausgeschlossene 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 dem Parameter attributes verwendet werden. Datentyp: Zeichenfolge Standard: Keine Felder ausschließen.
filter	Filterausdruck, der auf die zurückgegebenen Ergebnisse angewendet werden soll. Feldfilter werden ausgedrückt als<field_name><operator> <"Wert">. Unter RFC7644 finden Sie eine Liste der gültigen Operatoren. Hinweis: Der NOT- Operator wird von dieser Methode nicht unterstützt. Um beispielsweise nach allen Gruppen zu filtern, deren Name mit „HR“ beginnt, geben Sie displayName SW „HR“ein. Um mehr als einen Feldfilter anzugeben, verketten Sie die Filter mit dem AND- Operanden. Um beispielsweise nach allen Gruppen zu filtern, deren Name mit „HR“ beginnt und die zuletzt vor dem 3. Oktober 2021 geändert wurden, geben Sie displayName SW „HR“ AND meta.lastModified lt „2021-10-33T00:00:00Z“ ein. Verwenden Sie Dot-Walking, um verschachtelte Attribute anzugeben. Nur die folgenden SCIM-Gruppenfelder können in Filtern verwendet werden: displayName externalId: Unterstützt nur EQ- Operator. id meta.created meta.lastModified Datentyp: Zeichenfolge Standard: Keine Filterung
sortBy	Muss mit dem Parameter sortOrder angegeben werden. Feld, nach dem die zurückgegebenen Ergebnisse sortiert werden sollen. Bei der Sortierung wird die Groß-/Kleinschreibung beachtet. Sie können nur die Parameter verwenden, die für die Filterung nach dem Parameter sortBy verfügbar sind, mit der Ausnahme, dass externalId nicht zulässig ist. Für Werte, die null sind: Sortiert nach aufsteigend: Nullwerte werden nach oben sortiert. Sortiert nach absteigend: Nullwerte werden nach unten sortiert. Datentyp: Zeichenfolge Standard: Keine Sortierung
sortOrder	Muss mit dem Parameter sortBy angegeben werden. Reihenfolge, in der der Parameter sortBy auf die Rückgabeergebnisse angewendet wird. Gültige Werte: Aufsteigend Absteigend Datentyp: Zeichenfolge Standard: aufsteigend
startIndex	Einbasierter Index in der Tabelle, ab der mit dem Abrufen von Datensätzen begonnen werden soll. Wenn Sie diesen Parameter beispielsweise auf 100 und den Parameter count auf 20 festlegen, gibt der Endpunkt die Datensätze 100 bis 119 zurück. Hinweis: Jeder Wert, der auf weniger als eins festgelegt ist, wird als eins interpretiert. Datentyp: Zeichenfolge Standard: 1

Tabelle : 21. Anforderungstextparameter (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/json oder 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 HTTP-Antwortcodesder REST-API.

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 die Abfrageparameter attributes und excludedAttributes nicht in der Anforderung übergeben wurden. Stellen Sie sicher, dass der Parameter count nicht größer als 500 ist. Stellen Sie sicher, dass alle Parameter filter gültig sind.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
itemsProSeite	Anzahl der Datensätze, die in den Rückgabeergebnissen zurückgegeben werden. 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 zur Organisation der Gruppe. Datentyp: Objekt "company": { "display": "String", "$ref": "String", "value": "String" }
Resources.company.display	Name des Unternehmens. Datentyp: Zeichenfolge
Ressourcen.company.$ref	Referenz-URI des Unternehmens. Format:<host> /Unternehmen/<company sys_id> , wie zum Beispiel: http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 . Datentyp: Zeichenfolge
Resources.company.value	Sys_id des zugeordneten Unternehmens. Datentyp: Zeichenfolge
Resources.displayName	Visuell lesbarer Name der Gruppe, z. B. HR-Team. Datentyp: Zeichenfolge
Resources.externalId	Eindeutiger Bezeichner, der der Gruppe von der Entität zugewiesen wird, die sie bereitstellt. Datentyp: Zeichenfolge
Resources.id	Sys_id der Gruppe. Datentyp: Zeichenfolge
Resources.meta	Metadaten, die zur Gruppe gehören. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
Resources.meta.created	Datum und Uhrzeit der Erstellung des Gruppendatensatzes. Datentyp: Zeichenfolge
Resources.meta.lastModified	Datum und Uhrzeit der letzten Änderung des Gruppendatensatzes. Datentyp: Zeichenfolge
Resources.meta.location	URI der abgerufenen Gruppe. Datentyp: Zeichenfolge
Resources.meta.resourceType	Ressourcentyp der SCIM-Gruppe Datentyp: Zeichenfolge
Resources.members	Liste der Benutzer und Gruppen, die der Gruppe zugeordnet sind. Datentyp: Array von Objekten "members": [ { "display": "String", "value": "String", "$ref": "String" } ]
Resources.members.display	Name des zugeordneten Gruppenmitglieds. Datentyp: Zeichenfolge
Resources.members.value	Sys_id des zugeordneten Benutzer- oder Gruppendatensatzes. Datentyp: Zeichenfolge
Ressourcen.Mitglieder.$ref	URI des zugeordneten Gruppenmitglieds. Datentyp: Zeichenfolge
Resources.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:Group: Kernschema, das im Internet Engineering Task Force-System für Cross-Domain Identity Management: Core Schema-Dokument (https://datatracker.ietf.org/doc/html/rfc7643#section-4.2) angegeben ist urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group: ServiceNow Erweiterungsschema. Dieses Schema enthält Attribute, die in der Gruppentabelle [sys_user_group] in einem Basissystem ServiceNow vorhanden sind, aber nicht Teil des Kernschemas sind. urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group“ – Benutzerdefiniertes Erweiterungsschema. Dieses Schema ist Teil des Ressourcentyps „Gruppe“ in der Tabelle „sys_scim_schema_extension“. Wenn das Schema nicht aktiv ist, wird die Schema-URN nicht in der Antwort zurückgegeben. Datentyp: Array von Zeichenfolgen
-Schemata	Liste der URIs der SCIM-Listenantwortschemata, die zur Verarbeitung der Anforderung verwendet werden. Datentyp: Array
startIndex	Einbasierter Index in der Gruppentabelle [sys_user_group], ab der der Endpunkt mit dem Abrufen von Datensätzen begonnen hat. Datentyp: Zahl
totalResults	Gesamtzahl 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 dem Parameter count angefordert werden.

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 ausgeschlossenen Attributen

Dieses Beispiel zeigt, wie mehrere Gruppen (in diesem Fall vier) mit dem Parameter count angefordert werden und die Felder „meta“ und „members“ ausgeschlossen werden.

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 Gruppentabelle [sys_user_group] innerhalb einer ServiceNow -Instanz unter Verwendung des SCIM-Protokolls (System for Cross-Domain Identity Management) zurück.

URL-Format

Versionierte URL: /api/now/{api_version}/scim/Groups/{group_id}

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

Unterstützte Anforderungsparameter

Tabelle : 25. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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
attributes	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit dem Parameter excludedAttributes verwendet werden. Datentyp: Zeichenfolge Standard: Gibt alle Felder zurück, es sei denn, excludedAttributes ist angegeben.
ausgeschlossene 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 dem Parameter attributes verwendet werden. Datentyp: Zeichenfolge Standard: Keine Felder ausschließen.

Tabelle : 27. Anforderungstextparameter (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/json oder 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 HTTP-Antwortcodesder REST-API.

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 die Abfrageparameter attributes und excludedAttributes nicht in der Anforderung übergeben wurden. Stellen Sie sicher, dass der Parameter count nicht größer als 500 ist. Stellen Sie sicher, dass alle Parameter filter gültig sind.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
Unternehmen	Details zum Unternehmen oder zur Organisation der Gruppe. Datentyp: Objekt "company": { "display": "String", "$ref": "String", "value": "String" }
unternehmen.anzeigen	Name des Unternehmens. Datentyp: Zeichenfolge
Unternehmen.$ref	Referenz-URI des Unternehmens. Format:<host> /Unternehmen/<company sys_id> , wie zum Beispiel: http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 . Datentyp: Zeichenfolge
unternehmen.wert	Sys_id des zugeordneten Unternehmens. Datentyp: Zeichenfolge
displayName	Visuell lesbarer Name der Gruppe, z. B. HR-Team. Datentyp: Zeichenfolge
externe ID	Eindeutiger Bezeichner, der der Gruppe von der Entität zugewiesen wird, die sie bereitstellt. Datentyp: Zeichenfolge
id	Sys_id der Gruppe. Datentyp: Zeichenfolge
meta	Metadaten, die zur Gruppe gehören. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
meta.created	Datum und Uhrzeit der Erstellung des Gruppendatensatzes. Datentyp: Zeichenfolge
meta.lastModified	Datum und Uhrzeit der letzten Änderung des Gruppendatensatzes. Datentyp: Zeichenfolge
meta.location	URI der abgerufenen Gruppe. Datentyp: Zeichenfolge
meta.resourceType	Ressourcentyp der SCIM-Gruppe Datentyp: Zeichenfolge
Mitglieder	Liste der Benutzer und Gruppen, die der Gruppe zugeordnet sind. Datentyp: Array von Objekten "members": [ { "display": "String", "value": "String", "$ref": "String" } ]
Mitglieder.anzeigen	Name des zugeordneten Gruppenmitglieds. Datentyp: Zeichenfolge
Mitglieder.Wert	Sys_id des zugeordneten Benutzer- oder Gruppendatensatzes. Datentyp: Zeichenfolge
Mitglieder.$ref	URI des zugeordneten Gruppenmitglieds. Datentyp: Zeichenfolge
-Schemata	Liste der URIs der SCIM-Gruppenschemata, die zur Verarbeitung der Anforderung verwendet werden. Unterstützte Gruppenschemas: urn:ietf:params:scim:schemas:core:2.0:Group: Kernschema, das im Internet Engineering Task Force-System für Cross-Domain Identity Management: Core Schema-Dokument (https://datatracker.ietf.org/doc/html/rfc7643#section-4.2) angegeben ist urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group: ServiceNow Erweiterungsschema. Dieses Schema enthält Attribute, die in der Gruppentabelle [sys_user_group] in einem Basissystem ServiceNow vorhanden sind, aber nicht Teil des Kernschemas sind. urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group“ – Benutzerdefiniertes Erweiterungsschema. Dieses Schema ist Teil des Ressourcentyps „Gruppe“ in der Tabelle „sys_scim_schema_extension“. Wenn das Schema nicht aktiv ist, wird die Schema-URN nicht in der Antwort 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 das Hinzufügen, Aktualisieren und Löschen angegebener Felder in einem Gruppendatensatz in der Gruppentabelle [sys_user_group] einer Instanz ServiceNow mithilfe des SCIM-Protokolls (System for Cross-Domain Identity Management).

Weitere Informationen finden Sie im Abschnitt „Ändern mit PATCH “ 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. Zum 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.

Tabelle : 32. Abfrageparameter

Name	Beschreibung
attributes	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit dem Parameter excludedAttributes verwendet werden. Datentyp: Zeichenfolge Standard: Gibt alle Felder zurück, es sei denn, excludedAttributes ist angegeben.
ausgeschlossene 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 dem Parameter attributes verwendet werden. Datentyp: Zeichenfolge Standard: Keine Felder ausschließen.

Tabelle : 33. Anforderungstextparameter (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 } ]
Operations.op	Erforderlich. Auszuführender Vorgang. Gültige Werte: add: Fügen Sie das angegebene Feld und den angegebenen Wert dem Gruppendatensatz hinzu. entfernen: Entfernen Sie den Wert aus dem angegebenen Feld. Ersetzt durch Datentyp „null“. Ersetzen: Ersetzen Sie den Wert des angegebenen Felds. Datentyp: Zeichenfolge
Operations.path	Erforderlich für Entfernungsvorgänge, optional für andere. Name/Pfad des zu ändernden Felds. Der Parameter path 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.: emails[type eq "work"] { "schemas": [ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ], "Operations": [ { "op": "add", "path": "displayName", "value": "HR Group" }, { "op": "replace", "path": "members[value eq \"sysid1\"]", "value": { "value": "sysid2" } } ] } Datentyp: Zeichenfolge Standard: Betrachtet das Feld als Ressource.
Operations.value	Wert des im Parameter Operations.path angegebenen Felds. Das Format dieses Parameters hängt vom Datentyp des zugeordneten Felds ab. Wenn Sie beispielsweise eine einfache Zeichenfolge wie den Titel aktualisieren, wird das Feld value als Zeichenfolge ausgedrückt. "Operations": [ { "op": "add", "path": "displayName", "value": "HR Group" } ] Sie können auch einfache Zeichenfolgenwerte ohne path -Parameter deklarieren, 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 die URN des zugeordneten Schemas angibt. "value": { "<schema_urn>": { "<field_name>": "<new_value>" }, } 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
-Schemata	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/json oder application/scim+json. Standard: application/json
Content-Type	Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder 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 HTTP-Antwortcodesder REST-API.

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 ist abhängig vom Status der SCIM-UI-Eigenschaft ( Gruppen-Patch-API-Antwort mit Kein Inhalt aktivieren) und unterliegt dem Attributparameter, der gemäß RFC übergeben wird: https ://www.rfc-editor.org/rfc/rfc7644#page-35. Standardeigenschaftswert: false Die Eigenschaft Gruppen-Patch-API-Antwort ohne Inhalt aktivieren 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 geändert werden soll. Stellen Sie sicher, dass die Abfrageparameter attributes und excludedAttributes nicht in der Anforderung übergeben wurden 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. Der Parameter displayName 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 zur Organisation der Gruppe. Datentyp: Objekt "company": { "display": "String", "$ref": "String", "value": "String" }
unternehmen.anzeigen	Name des Unternehmens. Datentyp: Zeichenfolge
Unternehmen.$ref	Referenz-URI des Unternehmens. Format:<host> /Unternehmen/<company sys_id> , wie zum Beispiel: http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 . Datentyp: Zeichenfolge
unternehmen.wert	Sys_id des zugeordneten Unternehmens. Datentyp: Zeichenfolge
displayName	Visuell lesbarer Name der Gruppe, z. B. HR-Team. Datentyp: Zeichenfolge
externe ID	Eindeutiger Bezeichner, der der Gruppe von der Entität zugewiesen wird, 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" }
Fehler.detail	Detaillierte Fehlermeldung, warum die Anforderung fehlgeschlagen ist. Datentyp: Zeichenfolge
Fehler.scimType	SCIM-Fehlerdetail-Schlüsselwort. Datentyp: Zeichenfolge
Fehler.Schemata	URI der SCIM-Schemata, 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
externe ID	Eindeutiger Bezeichner, der der Gruppe von der Entität zugewiesen wird, die sie bereitstellt. Datentyp: Zeichenfolge
id	Sys_id der Gruppe. Datentyp: Zeichenfolge
Mitglieder	Liste der Benutzer und Gruppen, die der Gruppe zugeordnet sind. Datentyp: Array von Objekten "members": [ { "display": "String", "value": "String", "$ref": "String" } ]
Mitglieder.anzeigen	Name des zugeordneten Gruppenmitglieds. Datentyp: Zeichenfolge
Mitglieder.Wert	Sys_id des zugeordneten Benutzer- oder Gruppendatensatzes. Datentyp: Zeichenfolge
Mitglieder.$ref	URI des zugeordneten Gruppenmitglieds. Datentyp: Zeichenfolge
meta	Metadaten, die zur Gruppe gehören. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
meta.created	Datum und Uhrzeit der Erstellung des Gruppendatensatzes. Datentyp: Zeichenfolge
meta.lastModified	Datum und Uhrzeit der letzten Änderung des Gruppendatensatzes. Datentyp: Zeichenfolge
meta.location	URI der abgerufenen Gruppe. Datentyp: Zeichenfolge
meta.resourceType	Ressourcentyp der SCIM-Gruppe Datentyp: Zeichenfolge
-Schemata	Liste der URIs der SCIM-Gruppenschemata, die zur Verarbeitung der Anforderung verwendet werden. Unterstützte Gruppenschemas: urn:ietf:params:scim:schemas:core:2.0:Group: Kernschema, das im Internet Engineering Task Force-System für Cross-Domain Identity Management: Core Schema-Dokument (https://datatracker.ietf.org/doc/html/rfc7643#section-4.2) angegeben ist urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group: ServiceNow Erweiterungsschema. Dieses Schema enthält Attribute, die in der Gruppentabelle [sys_user_group] in einem Basissystem ServiceNow vorhanden sind, aber nicht Teil des Kernschemas sind. urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group“ – Benutzerdefiniertes Erweiterungsschema. Dieses Schema ist Teil des Ressourcentyps „Gruppe“ in der Tabelle „sys_scim_schema_extension“. Wenn das Schema nicht aktiv ist, wird die Schema-URN nicht in der Antwort 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 zugeordneten Mitglieder (Benutzer) 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 Gruppentabelle [sys_user_group] einer Instanz ServiceNow unter Verwendung des SCIM-Protokolls (System for Cross-Domain Identity Management).

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

Hinweis:

Die in der RFC7643-Spezifikation genannten Funktionen für Suche und Massenänderung werden von diesem Endpunkt nicht unterstützt.

URL-Format

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

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

Unterstützte Anforderungsparameter

Tabelle : 37. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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
attributes	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit dem Parameter excludedAttributes verwendet werden. Datentyp: Zeichenfolge Standard: Gibt alle Felder zurück, es sei denn, excludedAttributes ist angegeben.
ausgeschlossene 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 dem Parameter attributes verwendet werden. Datentyp: Zeichenfolge Standard: Keine Felder ausschließen.

Tabelle : 39. Anforderungstextparameter (JSON)

Name	Beschreibung
Unternehmen	Details zum Unternehmen oder zur Organisation der Gruppe. Datentyp: Objekt "company": { "display": "String", "$ref": "String", "value": "String" }
unternehmen.anzeigen	Name des Unternehmens. Datentyp: Zeichenfolge
Unternehmen.$ref	Referenz-URI des Unternehmens. Format:<host> /Unternehmen/<company sys_id> , wie zum Beispiel: http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 . Datentyp: Zeichenfolge
unternehmen.wert	Sys_id des zugeordneten Unternehmens. Datentyp: Zeichenfolge
displayName	Erforderlich. Visuell lesbarer Name der Gruppe, z. B. HR-Team. Datentyp: Zeichenfolge
externe ID	Eindeutiger Bezeichner, der der Gruppe von der Entität zugewiesen wird, die sie bereitstellt. Datentyp: Zeichenfolge
Mitglieder	Liste der Benutzer 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 zugeordneten Benutzer- oder Gruppendatensatzes. Datentyp: Zeichenfolge
-Schemata	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:Group: Kernschema, das im Internet Engineering Task Force-System für Cross-Domain Identity Management: Core Schema-Dokument (https://datatracker.ietf.org/doc/html/rfc7643#section-4.2) angegeben ist urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group: ServiceNow Erweiterungsschema. Dieses Schema enthält Attribute, die in der Gruppentabelle [sys_user_group] in einem Basissystem ServiceNow vorhanden sind, aber nicht Teil des Kernschemas sind. urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group“ – Benutzerdefiniertes Erweiterungsschema. Dieses Schema ist Teil des Ressourcentyps „Gruppe“ in der Tabelle „sys_scim_schema_extension“. Wenn das Schema nicht aktiv ist, wird die Schema-URN nicht in der Antwort 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/json oder application/scim+json. Standard: application/json
Content-Type	Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder 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 HTTP-Antwortcodesder REST-API.

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 geändert werden soll. Stellen Sie sicher, dass die Abfrageparameter attributes und excludedAttributes nicht in der Anforderung übergeben wurden oder dass die Anforderung die maximale Anzahl von Mitgliedern nicht überschreitet.
409	Gruppe ist bereits vorhanden. Der Parameter displayName 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 zur Organisation der Gruppe. Datentyp: Objekt "company": { "display": "String", "$ref": "String", "value": "String" }
unternehmen.anzeigen	Name des Unternehmens. Datentyp: Zeichenfolge
Unternehmen.$ref	Referenz-URI des Unternehmens. Format:<host> /Unternehmen/<company sys_id> , wie zum Beispiel: http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 . Datentyp: Zeichenfolge
unternehmen.wert	Sys_id des zugeordneten Unternehmens. Datentyp: Zeichenfolge
displayName	Visuell lesbarer Name der Gruppe, z. B. HR-Team. Datentyp: Zeichenfolge
externe ID	Eindeutiger Bezeichner, der der Gruppe von der Entität zugewiesen wird, die sie bereitstellt. Datentyp: Zeichenfolge
id	Sys_id der Gruppe. Datentyp: Zeichenfolge
meta	Metadaten, die zur Gruppe gehören. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
meta.created	Datum und Uhrzeit der Erstellung des Gruppendatensatzes. Datentyp: Zeichenfolge
meta.lastModified	Datum und Uhrzeit der letzten Änderung des Gruppendatensatzes. Datentyp: Zeichenfolge
meta.location	URI der abgerufenen Gruppe. Datentyp: Zeichenfolge
meta.resourceType	Ressourcentyp der SCIM-Gruppe Datentyp: Zeichenfolge
Mitglieder	Liste der Benutzer und Gruppen, die der Gruppe zugeordnet sind. Datentyp: Array von Objekten "members": [ { "display": "String", "value": "String", "$ref": "String" } ]
Mitglieder.anzeigen	Name des zugeordneten Gruppenmitglieds. Datentyp: Zeichenfolge
Mitglieder.Wert	Sys_id des zugeordneten Benutzer- oder Gruppendatensatzes. Datentyp: Zeichenfolge
Mitglieder.$ref	URI des zugeordneten Gruppenmitglieds. Datentyp: Zeichenfolge
-Schemata	Liste der URIs der SCIM-Gruppenschemata, die zur Verarbeitung der Anforderung verwendet werden. Unterstützte Gruppenschemas: urn:ietf:params:scim:schemas:core:2.0:Group: Kernschema, das im Internet Engineering Task Force-System für Cross-Domain Identity Management: Core Schema-Dokument (https://datatracker.ietf.org/doc/html/rfc7643#section-4.2) angegeben ist urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group: ServiceNow Erweiterungsschema. Dieses Schema enthält Attribute, die in der Gruppentabelle [sys_user_group] in einem Basissystem ServiceNow vorhanden sind, aber nicht Teil des Kernschemas sind. urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group“ – Benutzerdefiniertes Erweiterungsschema. Dieses Schema ist Teil des Ressourcentyps „Gruppe“ in der Tabelle „sys_scim_schema_extension“. Wenn das Schema nicht aktiv ist, wird die Schema-URN nicht in der Antwort zurückgegeben. Datentyp: Array von Zeichenfolgen

cURL fordert POST einer neuen Gruppe an und fügt Mitglied hinzu

In diesem Beispiel wird group51 erstellt und der Benutzer 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 Gruppentabelle [sys_user_group] einer Instanz ServiceNow mit dem SCIM-Protokoll (System for Cross-Domain Identity Management).

Felder, die in der Anforderung ausgelassen wurden, werden nicht aktualisiert. Sie können ein Feld explizit löschen, indem Sie seinen Wert für ein Einzelwertfeld auf NULL und für Felder vom Typ Array wie membersauf ein leeres Array festlegen.

URL-Format

Versionierte URL: /api/now/{api_version}/scim/Groups/{group_id}

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

Unterstützte Anforderungsparameter

Tabelle : 43. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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.

Tabelle : 44. Abfrageparameter

Name	Beschreibung
attributes	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit dem Parameter excludedAttributes verwendet werden. Datentyp: Zeichenfolge Standard: Gibt alle Felder zurück, es sei denn, excludedAttributes ist angegeben.
ausgeschlossene 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 dem Parameter attributes verwendet werden. Datentyp: Zeichenfolge Standard: Keine Felder ausschließen.

Tabelle : 45. Anforderungstextparameter (JSON)

Name	Beschreibung
Unternehmen	Details zum Unternehmen oder zur Organisation der Gruppe. Datentyp: Objekt "company": { "display": "String", "$ref": "String", "value": "String" }
unternehmen.anzeigen	Name des Unternehmens. Datentyp: Zeichenfolge
Unternehmen.$ref	Referenz-URI des Unternehmens. Format:<host> /Unternehmen/<company sys_id> , wie zum Beispiel: http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 . Datentyp: Zeichenfolge
unternehmen.wert	Sys_id des zugeordneten Unternehmens. Datentyp: Zeichenfolge
displayName	Visuell lesbarer Name der Gruppe, z. B. HR-Team. Datentyp: Zeichenfolge
externe ID	Eindeutiger Bezeichner, der der Gruppe von der Entität zugewiesen wird, die sie bereitstellt. Datentyp: Zeichenfolge
Mitglieder	Liste der Benutzer, durch die die aktuelle Mitgliederliste 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 zugeordneten Benutzer- oder Gruppendatensatzes. Datentyp: Zeichenfolge
-Schemata	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:Group: Kernschema, das im Internet Engineering Task Force-System für Cross-Domain Identity Management: Core Schema-Dokument (https://datatracker.ietf.org/doc/html/rfc7643#section-4.2) angegeben ist urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group: ServiceNow Erweiterungsschema. Dieses Schema enthält Attribute, die in der Gruppentabelle [sys_user_group] in einem Basissystem ServiceNow vorhanden sind, aber nicht Teil des Kernschemas sind. urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group“ – Benutzerdefiniertes Erweiterungsschema. Dieses Schema ist Teil des Ressourcentyps „Gruppe“ in der Tabelle „sys_scim_schema_extension“. Wenn das Schema nicht aktiv ist, wird die Schema-URN nicht in der Antwort 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/json oder application/scim+json. Standard: application/json
Content-Type	Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder 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 HTTP-Antwortcodesder REST-API.

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 geändert werden soll. Stellen Sie sicher, dass die Abfrageparameter attributes und excludedAttributes nicht in der Anforderung übergeben wurden 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. Der Parameter displayName 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 zur Organisation der Gruppe. Datentyp: Objekt "company": { "display": "String", "$ref": "String", "value": "String" }
unternehmen.anzeigen	Name des Unternehmens. Datentyp: Zeichenfolge
Unternehmen.$ref	Referenz-URI des Unternehmens. Format:<host> /Unternehmen/<company sys_id> , wie zum Beispiel: http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 . Datentyp: Zeichenfolge
unternehmen.wert	Sys_id des zugeordneten 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" }
Fehler.detail	Detaillierte Fehlermeldung, warum die Anforderung fehlgeschlagen ist. Datentyp: Zeichenfolge
Fehler.scimType	SCIM-Fehlerdetail-Schlüsselwort. Datentyp: Zeichenfolge
Fehler.Schemata	URI der SCIM-Schemata, die zur Verarbeitung der Fehlerantwort verwendet werden. Datentyp: Array von Zeichenfolgen
Fehler.Status	HTTP-Statuscode für die Fehlerantwort. Datentyp: Zeichenfolge
externe ID	Eindeutiger Bezeichner, der der Gruppe von der Entität zugewiesen wird, die sie bereitstellt. Datentyp: Zeichenfolge
id	Sys_id der Gruppe. Datentyp: Zeichenfolge
Mitglieder	Liste der Benutzer und Gruppen, die der Gruppe zugeordnet sind. Datentyp: Array von Objekten "members": [ { "display": "String", "value": "String", "$ref": "String" } ]
Mitglieder.anzeigen	Name des zugeordneten Gruppenmitglieds. Datentyp: Zeichenfolge
Mitglieder.Wert	Sys_id des zugeordneten Benutzer- oder Gruppendatensatzes. Datentyp: Zeichenfolge
Mitglieder.$ref	URI des zugeordneten Gruppenmitglieds. Datentyp: Zeichenfolge
meta	Metadaten, die zur Gruppe gehören. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
meta.created	Datum und Uhrzeit der Erstellung des Gruppendatensatzes. Datentyp: Zeichenfolge
meta.lastModified	Datum und Uhrzeit der letzten Änderung des Gruppendatensatzes. Datentyp: Zeichenfolge
meta.location	URI der abgerufenen Gruppe. Datentyp: Zeichenfolge
meta.resourceType	Ressourcentyp der SCIM-Gruppe Datentyp: Zeichenfolge
-Schemata	Liste der URIs der SCIM-Gruppenschemata, die zur Verarbeitung der Anforderung verwendet werden. Unterstützte Gruppenschemas: urn:ietf:params:scim:schemas:core:2.0:Group: Kernschema, das im Internet Engineering Task Force-System für Cross-Domain Identity Management: Core Schema-Dokument (https://datatracker.ietf.org/doc/html/rfc7643#section-4.2) angegeben ist urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group: ServiceNow Erweiterungsschema. Dieses Schema enthält Attribute, die in der Gruppentabelle [sys_user_group] in einem Basissystem ServiceNow vorhanden sind, aber nicht Teil des Kernschemas sind. urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group“ – Benutzerdefiniertes Erweiterungsschema. Dieses Schema ist Teil des Ressourcentyps „Gruppe“ in der Tabelle „sys_scim_schema_extension“. Wenn das Schema nicht aktiv ist, wird die Schema-URN nicht in der Antwort zurückgegeben. Datentyp: Array von Zeichenfolgen

cURL-Anforderung zum Aktualisieren von Gruppenmitgliedern mit PUT

Im folgenden Beispiel wird das der Gruppe zugeordnete Mitglied in Abraham Lincoln anstelle von Abel Tutor 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 – DELETE /scim/Users/{user_id}

Löscht den angegebenen Benutzerdatensatz aus der Benutzertabelle [sys_user] einer Instanz ServiceNow mithilfe des SCIM-Protokolls (System for Cross-Domain Identity Management).

URL-Format

Versionierte URL: /api/now/{api_version}/scim/Users/{user_id}

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

Unterstützte Anforderungsparameter

Tabelle : 49. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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 Benutzerdatensatzes.

Tabelle : 50. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 51. Anforderungstextparameter (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/json oder 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 HTTP-Antwortcodesder REST-API.

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" }
Fehler.detail	Detaillierte Fehlermeldung, warum die Anforderung fehlgeschlagen ist. Datentyp: Zeichenfolge
Fehler.scimType	SCIM-Fehlerdetail-Schlüsselwort. Datentyp: Zeichenfolge
Fehler.Schemata	URI der SCIM-Schemata, 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 Benutzerdatensatz aus der Benutzertabelle [sys_user] gelöscht wird.

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

SCIM – GET /scim/Users

Gibt einen oder mehrere Benutzerdatensätze aus der Benutzertabelle [sys_user] in einer Instanz ServiceNow zurück, wobei das SCIM-Protokoll (System for Cross-Domain Identity Management) verwendet wird.

Hinweis:

Eine Abfrage, die keine Übereinstimmungen zurückgibt, gibt „Success“ (HTTP-Statuscode 200) zurück, wobei totalResults auf 0 festgelegt ist.

URL-Format

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

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

Unterstützte Anforderungsparameter

Tabelle : 55. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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
attributes	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit dem Parameter excludedAttributes verwendet werden. Datentyp: Zeichenfolge Standard: Gibt alle Felder zurück, es sei denn, excludedAttributes ist angegeben.
count	Anzahl der zurückzugebenden Datensätze. Ein negativer Wert wird als Null interpretiert. Datentyp: Zahl Maximum: 500 – Ein größerer Wert führt zu einem Fehler bei der Anforderung. Standard: 10
ausgeschlossene 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 dem Parameter attributes verwendet werden. Datentyp: Zeichenfolge Standard: Keine Felder ausschließen.
filter	Filterausdruck, der auf die zurückgegebenen Ergebnisse angewendet werden soll. Feldfilter werden ausgedrückt als<field_name><operator> <"Wert">. Unter RFC7644 finden Sie eine Liste der gültigen Operatoren. Hinweis: Der NOT- Operator wird nicht unterstützt. Um beispielsweise nach allen Benutzern zu filtern, deren Name mit „Jo“ beginnt, geben Sie userName SW „jo“ ein (Groß-/Kleinschreibung beachten). Um mehr als einen Feldfilter anzugeben, verketten Sie die Filter mit dem AND- Operanden. Um beispielsweise nach allen Benutzern zu filtern, deren Name mit „Jo“ beginnt und deren Nachname „smi“ enthält, geben Sie userName SW „john“ UND name.familyName CO „smi“ ein. Verwenden Sie Dot-Walking, um verschachtelte Attribute anzugeben. Nur die folgenden SCIM-Benutzerfelder 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.: [type eq „home“ and StreetAddress eq „xxxx“] [type eq „home“ and locality eq „xxxx“] [type eq „home“ und Region eq „xxxx“] [type eq „home“ and postalCode eq „xxxx“] [Typ-EQ „home“ und Land EQ „xxxx“] displayName E-Mails: Nur festes Format, z. B.: [type eq „work“ and value eq „emailValue“] externalId: Nur EQ- Operator wird unterstützt. id meta.created meta.lastModified name.familiename name.givenName name.middleName bevorzugteSprache phoneNumbers: Nur festes Format, z. B.: [type eq „work“ and value eq „xxxx“] [type eq „mobile“ and value eq „xxxx“] [type eq „home“ and value eq „xxxx“] Feld Titel userName urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:employeeNumber urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:gender urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:department.name urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:department.value urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:manager.displayName urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:manager.value urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:costCenter.name urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:costCenter.value urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:company.name urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:company.value urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:location.name urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:location.value Datentyp: Zeichenfolge Standard: Keine Filterung
sortBy	Muss mit dem Parameter sortOrder angegeben werden. Feld, nach dem die zurückgegebenen Ergebnisse sortiert werden sollen. Bei der Sortierung wird die Groß-/Kleinschreibung beachtet. Sie können nur die Parameter verwenden, die für die Filterung nach dem Parameter sortBy verfügbar sind, mit Ausnahme von externalId, was nicht zulässig ist. Außerdem werden nur die folgenden Punkt-zu-Punkt-Parameter unterstützt: addressess Nur die folgenden Werte sind zulässig: addresses.streetAddress Zuordnung zur Privatadresse. addresses.home.streetAddress addresses.locality Zuordnungen zum Heimatort. addresses.home.locality addresses.region Zuordnungen zur Heimatregion. addresses.home.region addresses.postalCode Ordnet auf private Postleitzahl zu. addresses.home.postalCode addresses.country Zuordnungen zum Heimatland. addresses.home.country emails Nur die folgenden Werte sind zulässig: emails.value Ordnet auf den E-Mail-Typ Arbeit zu. emails.work.value phoneNumbers Nur die folgenden Werte sind zulässig: phoneNumbers.value Ordnet auf den Telefonnummerntyp Arbeit zu. phoneNumbers.home.value phoneNumbers.mobile.value phoneNumbers.work.value Für Werte, die null sind: Sortiert nach aufsteigend: Nullwerte werden nach oben sortiert. Sortiert nach absteigend: Nullwerte werden nach unten sortiert. Datentyp: Zeichenfolge Standard: Keine Sortierung durchgeführt
sortOrder	Muss mit dem Parameter sortBy angegeben werden. Reihenfolge, in der der Parameter sortBy auf die Rückgabeergebnisse angewendet wird. Gültige Werte: Aufsteigend Absteigend Datentyp: Zeichenfolge Standard: aufsteigend
startIndex	Einbasierter Index in der Benutzertabelle [sys_user], ab der mit dem Abrufen von Datensätzen begonnen werden soll. Wenn Sie diesen Parameter beispielsweise auf 100 und den Parameter count auf 20 festlegen, gibt der Endpunkt die Datensätze 100 bis 119 zurück. Hinweis: Jeder Wert, der auf weniger als eins festgelegt ist, wird als eins interpretiert. Ungültig mit dem id Pfadparameter . 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/json oder 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 HTTP-Antwortcodesder REST-API.

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 die Abfrageparameter attributes und excludedAttributes nicht in der Anforderung übergeben wurden. Stellen Sie sicher, dass der Parameter count nicht größer als 500 ist. Stellen Sie sicher, dass alle Parameter filter gültig sind.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
itemsProSeite	Anzahl der Datensätze, die in den Rückgabeergebnissen zurückgegeben werden. Datentyp: Zahl
Ressourcen	Liste der Benutzerdatensä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" } ]
Resources.active	Kennzeichnung, die angibt, ob der zugeordnete Benutzer in der Instanz ServiceNow aktiv ist. Mögliche Werte: true: Benutzer ist aktiv. false: Benutzer ist inaktiv. Datentyp: Boolesch
Resources.adresses	Details zur aktuellen Postanschrift des Benutzers. Datentyp: Objekt "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" }
Ressourcen.Adressen.Land	Ländername. Datentyp: Zeichenfolge
Ressourcen.Adressen.Ort	Stadt- oder Ortsname. Datentyp: Zeichenfolge
Resources.addresses.postalCode	Postleitzahl. Datentyp: Zeichenfolge
Ressourcen.Adressen.Region	Bundesland oder Region. Datentyp: Zeichenfolge
Resources.addresses.streetAddress	Vollständige Adresse mit Straße und Hausnummer. Dies kann Hausnummer, Straßenname, Postfach und mehrzeilige erweiterte Adresseninformationen umfassen. Datentyp: Zeichenfolge
Resources.addresses.type	Typ der Adresse. Unterstützt derzeit nur Homepage. Datentyp: Zeichenfolge
Resources.displayName	Benutzeranzeigename. Dieser Wert wird automatisch generiert, indem die Felder name verkettet werden. Datentyp: Zeichenfolge
Resources.emails	Liste der E-Mail-Accounts, die dem Benutzer zugeordnet sind. Datentyp: Array von Objekten "emails:" [ { "type": "String", "value": "String" } ]
Resources.emails.type	E-Mail-Typ des Benutzers. Unterstützt derzeit nur den Typ „Arbeit“. Datentyp: Zeichenfolge
Resources.emails.value	E-Mail-Adresse des Benutzers. Dies ist ein eindeutiger Schlüssel für den zugeordneten Benutzer. Datentyp: Zeichenfolge
Resources.externalId	Eindeutiger Bezeichner, der dem Benutzer von der Entität zugewiesen wird, die ihn bereitstellt. Datentyp: Zeichenfolge
Resources.groups	Liste der Gruppen, denen der Benutzer angehört, entweder durch direkte Mitgliedschaft, verschachtelte 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
Resources.id	Sys_id des zugeordneten Benutzerdatensatzes. Datentyp: Zeichenfolge
Resources.meta	Metadaten, die sich auf den Benutzer beziehen. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
Resources.meta.created	Datum und Uhrzeit der Erstellung des Benutzerdatensatzes. Datentyp: Zeichenfolge
Resources.meta.lastModified	Datum und Uhrzeit der letzten Änderung des Benutzerdatensatzes. Datentyp: Zeichenfolge
Resources.meta.location	URI des abgerufenen Benutzers. Datentyp: Zeichenfolge
Resources.meta.resourceType	Ressourcentyp des SCIM-Anwenders Datentyp: Zeichenfolge
Resources.name	Informationen zum Benutzernamen. Datentyp: Objekt "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" }
Resources.name.familyName	Familien- oder Nachname des Benutzers. Datentyp: Zeichenfolge
Ressourcen.Name.VorgegebenerName	Vorname oder Vorname des Benutzers. Datentyp: Zeichenfolge
Resources.name.honorificPrefix	Der ehrenwerte Name oder Titel des Benutzers, z. B. Dr., Biskuit oder Freibar. Datentyp: Zeichenfolge
Resources.name.middle	Zweiter Vorname des Benutzers. Datentyp: Zeichenfolge
Resources.phoneNumbers	Liste der Telefonnummern, die dem Benutzer zugeordnet sind. Datentyp: Array von Objekten "phoneNumbers": [ { "type": "String", "value": "String" } ]
Resources.phoneNumbers.type	Typ der Telefonnummer. Mögliche Werte: Homepage Mobile Arbeit Datentyp: Zeichenfolge
Resources.phoneNumbers.value	Telefonnummer des Benutzers. Datentyp: Zeichenfolge
Resources.preferredLanguage	Bevorzugte gesprochene und geschriebene Sprache des Benutzers. Datentyp: Zeichenfolge
Resources.schemas	Liste der URIs der SCIM-Benutzerschemata, die zur Verarbeitung der Anforderung verwendet werden. Datentyp: Array von Zeichenfolgen
Resources.timezone	Zeitzone des Benutzers. Datentyp: Zeichenfolge
Resources.title	Titel des Benutzers, z. B. CEO oder President. Datentyp: Zeichenfolge
Ressourcen.Benutzername	Eindeutiger Benutzername für den zugeordneten Benutzer. Datentyp: Zeichenfolge
Resources.userType	Benutzertyp. Dieser Wert wird verwendet, um die Beziehung zwischen Organisation und Benutzer zu identifizieren. Dies kann ein beliebiger Wert sein, aber typische Werte können sein: Vertragsunternehmen Mitarbeiter Praktikanten Temp Extern Unbekannt Datentyp: Zeichenfolge
-Schemata	Liste der URIs der SCIM-ListResponse-Schemata, die zur Verarbeitung der Anforderung verwendet werden. Datentyp: Array von Zeichenfolgen
startIndex	Einbasierter Index in der Benutzertabelle [sys_user], an der die Datensätze zurückgegeben wurden. Datentyp: Zeichenfolge
totalResults	Gesamtzahl der Datensätze, die der Anforderung entsprechen. Datentyp: Zahl

Erweiterungsparameter zurückgegeben

Name	Beschreibung
Unternehmen	Details zum zugeordneten Unternehmen des Benutzers. Datentyp: Objekt "company": { "display": "String", "value": "String", "$ref": "String" }
unternehmen.anzeigen	Name des Unternehmens. Datentyp: Zeichenfolge
unternehmen.wert	Sys_id des Unternehmensdatensatzes. Datentyp: Zeichenfolge
Unternehmen.$ref	Referenz-URI für das Unternehmen. Datentyp: Zeichenfolge
costCenter	Details zur zugeordneten Kostenstelle des Benutzers. Datentyp: Objekt "costCenter": { "display": "String", "value": "String", "$ref": "String" }
costCenter.display	Name der Kostenstelle. Datentyp: Zeichenfolge
costCenter.value	Sys_id des Kostenstellen-Datensatzes. Datentyp: Zeichenfolge
costCenter.$ref	Referenz-URI für die Kostenstelle. Datentyp: Zeichenfolge
department	Details zur zugeordneten Abteilung des Benutzers. 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
employeeNumber	Numerische oder alphanumerische Mitarbeiternummer. Datentyp: Zeichenfolge
Geschlecht	Geschlecht des Benutzers, z. B. männlich oder frau. Datentyp: Zeichenfolge
location	Details zum zugeordneten Standort des Benutzers. Datentyp: Objekt "location": { "display": "String", "value": "String", "$ref": "String" }
location.display	Name des Standorts. Datentyp: Zeichenfolge
location.value	Sys_id des Standortdatensatzes. Datentyp: Zeichenfolge
Standort.$ref	Referenz-URI für den Standort. Datentyp: Zeichenfolge
Manager	Details zum zugeordneten Manager des Benutzers. Datentyp: Objekt "manager": { "display": "String", "value": "String", "$ref": "String" }
manager.display	Name des Managers. Datentyp: Zeichenfolge
manager.value	Sys_id des Manager-Datensatzes. Datentyp: Zeichenfolge
manager.$ref	Referenz-URI für den Manager. Datentyp: Zeichenfolge

cURL-Anforderung mit Attributen

Das folgende Beispiel zeigt, wie zwei Benutzer ab dem sechsten Datensatz abgerufen und nur der Anzeigename zurückgegeben werden.

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 mit einem Filter

Das folgende Beispiel zeigt, wie Sie mit dem Parameter filter die ersten beiden Benutzerdatensätze zurückgeben, deren Vorname 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 – GET /scim/Users/{user_id}

Gibt den angegebenen Benutzerdatensatz aus der Benutzertabelle [sys_user] in einer Instanz ServiceNow unter Verwendung des SCIM-Protokolls (System for Cross-Domain Identity Management) zurück.

URL-Format

Versionierte URL: /api/now/{api_version}/scim/Users/{user_id}

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

Unterstützte Anforderungsparameter

Tabelle : 61. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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 Benutzerdatensatzes. Datentyp: Zeichenfolge

Tabelle : 62. Abfrageparameter

Name	Beschreibung
attributes	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit dem Parameter excludedAttributes verwendet werden. Datentyp: Zeichenfolge Standard: Gibt alle Felder zurück, es sei denn, excludedAttributes ist angegeben.
ausgeschlossene 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 dem Parameter attributes verwendet werden. Datentyp: Zeichenfolge Standard: Keine Felder ausschließen.

Tabelle : 63. Anforderungstextparameter (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/json oder 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 HTTP-Antwortcodesder REST-API.

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 die Abfrageparameter attributes und excludedAttributes nicht in der Anforderung übergeben wurden. Stellen Sie sicher, dass der Parameter count nicht größer als 500 ist. Stellen Sie sicher, dass alle Parameter filter gültig sind.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
aktiv	Kennzeichnung, die angibt, ob der zugeordnete Benutzer in der Instanz ServiceNow aktiv ist. Mögliche Werte: true: Benutzer ist aktiv. false: Benutzer ist inaktiv. Datentyp: Boolesch
addresses	Details zur aktuellen Postanschrift des Benutzers. Datentyp: Objekt "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" }
adressen.land	Ländername. Datentyp: Zeichenfolge
adressen.ort	Stadt- oder Ortsname. Datentyp: Zeichenfolge
adressen.postalCode	Postleitzahl. Datentyp: Zeichenfolge
adressen.region	Bundesland oder Region. Datentyp: Zeichenfolge
adressen.straßeAdresse	Vollständige Adresse mit Straße und Hausnummer. Dies kann Hausnummer, Straßenname, Postfach und mehrzeilige erweiterte Adresseninformationen umfassen. Datentyp: Zeichenfolge
address.type	Typ der Adresse. Unterstützt derzeit nur Homepage. Datentyp: Zeichenfolge
displayName	Benutzeranzeigename. Dieser Wert wird automatisch generiert, indem die Felder name verkettet werden. Datentyp: Zeichenfolge
E-Mails	Liste der E-Mail-Accounts, die dem Benutzer zugeordnet sind. Datentyp: Array von Objekten "emails:" [ { "type": "String", "value": "String" } ]
emails.type	E-Mail-Typ des Benutzers. Unterstützt derzeit nur den Typ „Arbeit“. Datentyp: Zeichenfolge
emails.value	E-Mail-Adresse des Benutzers. Dies ist ein eindeutiger Schlüssel für den zugeordneten Benutzer. Datentyp: Zeichenfolge
externe ID	Eindeutiger Bezeichner, der dem Benutzer von der Entität zugewiesen wird, die ihn bereitstellt. Datentyp: Zeichenfolge
groups	Liste der Gruppen, denen der Benutzer angehört, entweder durch direkte Mitgliedschaft, verschachtelte Gruppen oder dynamisch berechnet. Datentyp: Array von Objekten "groups": [ { "display": "String", "type": "String", "value": "String", "$ref": "String" } ]
groups.display	Name der zugeordneten Gruppe. Datentyp: Zeichenfolge
groups.type	Typ der Gruppenzuordnung, z. B. direkt oder indirekt. Datentyp: Zeichenfolge
groups.value	Sys_id eines zugeordneten Gruppendatensatzes. Datentyp: Zeichenfolge
Gruppen.$ref	URI der zugeordneten Gruppe. Datentyp: Zeichenfolge
id	Sys_id des zugeordneten Benutzerdatensatzes. Datentyp: Zeichenfolge
meta	Metadaten, die sich auf den Benutzer beziehen. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
meta.created	Datum und Uhrzeit der Erstellung des Benutzerdatensatzes. Datentyp: Zeichenfolge
meta.lastModified	Datum und Uhrzeit der letzten Änderung des Benutzerdatensatzes. Datentyp: Zeichenfolge
meta.location	URI des abgerufenen Benutzers. Datentyp: Zeichenfolge
meta.resourceType	Ressourcentyp des SCIM-Anwenders Datentyp: Zeichenfolge
Name	Informationen zum Benutzernamen. Datentyp: Objekt "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" }
name.familiename	Familien- oder Nachname des Benutzers. Datentyp: Zeichenfolge
name.givenName	Vorname oder Vorname des Benutzers. Datentyp: Zeichenfolge
name.honorificPrefix	Der ehrenwerte Name oder Titel des Benutzers, z. B. Dr., Biskuit oder Freibar. Datentyp: Zeichenfolge
name.middle	Zweiter Vorname des Benutzers. Datentyp: Zeichenfolge
phoneNumbers	Liste der Telefonnummern, die dem Benutzer zugeordnet sind. Datentyp: Array von Objekten "phoneNumbers": [ { "type": "String", "value": "String" } ]
phoneNumbers.type	Typ der Telefonnummer. Mögliche Werte: Homepage Mobile Arbeit Datentyp: Zeichenfolge
phoneNumbers.value	Telefonnummer des Benutzers. Datentyp: Zeichenfolge
bevorzugteSprache	Bevorzugte gesprochene und geschriebene Sprache des Benutzers. Datentyp: Zeichenfolge
-Schemata	Liste der URIs der SCIM-Benutzerschemata, die zur Verarbeitung der Anforderung verwendet werden. Datentyp: Array von Zeichenfolgen
Feld	Zeitzone des Benutzers. Datentyp: Zeichenfolge
Titel	Titel des Benutzers, z. B. CEO oder President. Datentyp: Zeichenfolge
userName	Eindeutiger Benutzername für den zugeordneten Benutzer. Datentyp: Zeichenfolge
userType	Benutzertyp. Dieser Wert wird verwendet, um die Beziehung zwischen Organisation und Benutzer zu identifizieren. Dies kann ein beliebiger Wert sein, aber typische Werte können sein: Vertragsunternehmen Mitarbeiter Praktikanten Temp Extern Unbekannt Datentyp: Zeichenfolge

Erweiterungsparameter zurückgegeben

Name	Beschreibung
Unternehmen	Details zum zugeordneten Unternehmen des Benutzers. Datentyp: Objekt "company": { "display": "String", "value": "String", "$ref": "String" }
unternehmen.anzeigen	Name des Unternehmens. Datentyp: Zeichenfolge
unternehmen.wert	Sys_id des Unternehmensdatensatzes. Datentyp: Zeichenfolge
Unternehmen.$ref	Referenz-URI für das Unternehmen. Datentyp: Zeichenfolge
costCenter	Details zur zugeordneten Kostenstelle des Benutzers. Datentyp: Objekt "costCenter": { "display": "String", "value": "String", "$ref": "String" }
costCenter.display	Name der Kostenstelle. Datentyp: Zeichenfolge
costCenter.value	Sys_id des Kostenstellen-Datensatzes. Datentyp: Zeichenfolge
costCenter.$ref	Referenz-URI für die Kostenstelle. Datentyp: Zeichenfolge
department	Details zur zugeordneten Abteilung des Benutzers. 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
employeeNumber	Numerische oder alphanumerische Mitarbeiternummer. Datentyp: Zeichenfolge
Geschlecht	Geschlecht des Benutzers, z. B. männlich oder frau. Datentyp: Zeichenfolge
location	Details zum zugeordneten Standort des Benutzers. Datentyp: Objekt "location": { "display": "String", "value": "String", "$ref": "String" }
location.display	Name des Standorts. Datentyp: Zeichenfolge
location.value	Sys_id des Standortdatensatzes. Datentyp: Zeichenfolge
Standort.$ref	Referenz-URI für den Standort. Datentyp: Zeichenfolge
Manager	Details zum zugeordneten Manager des Benutzers. Datentyp: Objekt "manager": { "display": "String", "value": "String", "$ref": "String" }
manager.display	Name des Managers. Datentyp: Zeichenfolge
manager.value	Sys_id des Manager-Datensatzes. Datentyp: Zeichenfolge
manager.$ref	Referenz-URI für den Manager. Datentyp: Zeichenfolge

cURL-Anforderung mit Benutzer-sys_id

Das folgende Beispiel zeigt, wie ein bestimmter Benutzerdatensatz durch Übergabe seiner sys_id abgerufen wird.

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 das Hinzufügen, Ersetzen und Entfernen angegebener Felder in einem Benutzerdatensatz in der Benutzertabelle [sys_user] einer Instanz ServiceNow mithilfe des SCIM-Protokolls (System for Cross-Domain Identity Management).

URL-Format

Versionierte URL: /api/now/{api_version}/scim/Users/{user_id}

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

Unterstützte Anforderungsparameter

Tabelle : 67. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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 Benutzerdatensatzes.

Tabelle : 68. Abfrageparameter

Name	Beschreibung
attributes	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit dem Parameter excludedAttributes verwendet werden. Datentyp: Zeichenfolge Standard: Gibt alle Felder zurück, es sei denn, excludedAttributes ist angegeben.
ausgeschlossene 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 dem Parameter attributes verwendet werden. Datentyp: Zeichenfolge Standard: Keine Felder ausschließen.

Tabelle : 69. Anforderungstextparameter (JSON)

Name	Beschreibung
Vorgänge	Erforderlich. Liste der Vorgangsobjekte, mit denen der angegebene Benutzerdatensatz gepatcht werden soll. Datentyp: Array "Operations": [ { "op": "String", "path": "String", "value": Any } ]
Operations.op	Erforderlich. Auszuführender Vorgang. Gültige Werte: add: Fügen Sie dem Benutzerdatensatz 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
Operations.path	Erforderlich für Entfernungsvorgänge. Name/Pfad des zu ändernden Felds. Der Parameter path kann eines der folgenden Formate haben: Ein direktes Feld, z. B. Titel Ein geschachteltes Feld, z. B. name.givenName Im Falle eines komplexen Arrays kann es auf ein bestimmtes Element mit einem Filter verweisen, z. B.: emails[type eq "work"] { "schemas": [ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ], "Operations": [ { "op": "add", "path": "title", "value": "xyz" }, { "op": "replace", "path": "name.givenName", "value": "Jennifer" }, { "op": "replace", "path": "emails[type eq \"work\"]", "value": "[e-mail]" } ] } Datentyp: Zeichenfolge Standard: Betrachtet das Feld als Benutzerressource.
Operations.value	Wert des im Parameter Operations.path angegebenen Felds. Das Format dieses Parameters hängt vom Datentyp des zugeordneten Felds ab. Wenn Sie beispielsweise eine einfache Zeichenfolge wie den Titel aktualisieren, wird das Feld value als Zeichenfolge ausgedrückt. "Operations": [ { "op": "add", "path": "title", "value": "xyz" } ] Sie können auch einfache Zeichenfolgenwerte deklarieren, ohne die Parameter value oder path zu verwenden, 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 Benutzerdatensatz und den zugehörigen Werten hinzugefügt werden sollen, wird das Feld value jedoch als Array von Objekten ausgedrückt. "Operations": [ { "op": "add", "path": "phoneNumbers", "value": [ { "type": "work", "value": "9876543210" }, { "type": "home", "value": "9876783216" } ] } ] Bei der Angabe von Attributknoten kann der Eintrag die Verschachtelung wie folgt enthalten: { "op": "replace", "value": { "name": { "familyName": "Jones", "givenName": "Jennifer" } } } Oder Sie können die Verschachtelung in Operations.pathangeben: { "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 die URN des zugeordneten Schemas angibt. "value": { "<schema_urn>": { "<field_name>": "<new_value>" }, } 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
-Schemata	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/json oder application/scim+json. Standard: application/json
Content-Type	Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder 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 HTTP-Antwortcodesder REST-API.

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 geändert werden soll. Stellen Sie sicher, dass die Abfrageparameter attributes und excludedAttributes nicht in der Anforderung übergeben wurden 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. Der Parameter userName 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 Benutzer in der Instanz ServiceNow aktiv ist. Mögliche Werte: true: Benutzer ist aktiv. false: Benutzer ist inaktiv. Datentyp: Boolesch
addresses	Details zur aktuellen Postanschrift des Benutzers. Datentyp: Objekt "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" }
adressen.land	Ländername. Datentyp: Zeichenfolge
adressen.ort	Stadt- oder Ortsname. Datentyp: Zeichenfolge
adressen.postalCode	Postleitzahl. Datentyp: Zeichenfolge
adressen.region	Bundesland oder Region. Datentyp: Zeichenfolge
adressen.straßeAdresse	Vollständige Adresse mit Straße und Hausnummer. Dies kann Hausnummer, Straßenname, Postfach und mehrzeilige erweiterte Adresseninformationen umfassen. Datentyp: Zeichenfolge
address.type	Typ der Adresse. Unterstützt derzeit nur Homepage. Datentyp: Zeichenfolge
displayName	Benutzeranzeigename. Dieser Wert wird automatisch generiert, indem die Felder name verkettet werden. Datentyp: Zeichenfolge
E-Mails	Liste der E-Mail-Accounts, die dem Benutzer zugeordnet sind. Datentyp: Array von Objekten "emails:" [ { "type": "String", "value": "String" } ]
emails.type	E-Mail-Typ des Benutzers. Unterstützt derzeit nur den Typ „Arbeit“. Datentyp: Zeichenfolge
emails.value	E-Mail-Adresse des Benutzers. Dies ist ein eindeutiger Schlüssel für den zugeordneten Benutzer. 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" }
Fehler.detail	Detaillierte Fehlermeldung, warum die Anforderung fehlgeschlagen ist. Datentyp: Zeichenfolge
Fehler.scimType	SCIM-Fehlerdetail-Schlüsselwort. Datentyp: Zeichenfolge
Fehler.Schemata	URI der SCIM-Schemata, die zur Verarbeitung der Fehlerantwort verwendet werden. Datentyp: Array von Zeichenfolgen
Fehler.Status	HTTP-Statuscode für die Fehlerantwort. Datentyp: Zeichenfolge
externe ID	Eindeutiger Bezeichner, der dem Benutzer von der Entität zugewiesen wird, die ihn bereitstellt. Datentyp: Zeichenfolge
groups	Liste der Gruppen, denen der Benutzer angehört, entweder durch direkte Mitgliedschaft, verschachtelte Gruppen oder dynamisch berechnet. Datentyp: Array von Objekten "groups": [ { "display": "String", "type": "String", "value": "String", "$ref": "String" } ]
groups.display	Name der zugeordneten Gruppe. Datentyp: Zeichenfolge
groups.type	Typ der Gruppenzuordnung, z. B. direkt oder indirekt. Datentyp: Zeichenfolge
groups.value	Sys_id eines zugeordneten Gruppendatensatzes. Datentyp: Zeichenfolge
Gruppen.$ref	URI der zugeordneten Gruppe. Datentyp: Zeichenfolge
id	Sys_id des zugeordneten Benutzerdatensatzes. Datentyp: Zeichenfolge
meta	Metadaten, die sich auf den Benutzer beziehen. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
meta.created	Datum und Uhrzeit der Erstellung des Benutzerdatensatzes. Datentyp: Zeichenfolge
meta.lastModified	Datum und Uhrzeit der letzten Änderung des Benutzerdatensatzes. Datentyp: Zeichenfolge
meta.location	URI des abgerufenen Benutzers. Datentyp: Zeichenfolge
meta.resourceType	Ressourcentyp des SCIM-Anwenders Datentyp: Zeichenfolge
Name	Informationen zum Benutzernamen. Datentyp: Objekt "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" }
name.familiename	Familien- oder Nachname des Benutzers. Datentyp: Zeichenfolge
name.givenName	Vorname oder Vorname des Benutzers. Datentyp: Zeichenfolge
name.honorificPrefix	Der ehrenwerte Name oder Titel des Benutzers, z. B. Dr., Biskuit oder Freibar. Datentyp: Zeichenfolge
name.middle	Zweiter Vorname des Benutzers. Datentyp: Zeichenfolge
phoneNumbers	Liste der Telefonnummern, die dem Benutzer zugeordnet sind. Datentyp: Array von Objekten "phoneNumbers": [ { "type": "String", "value": "String" } ]
phoneNumbers.type	Typ der Telefonnummer. Mögliche Werte: Homepage Mobile Arbeit Datentyp: Zeichenfolge
phoneNumbers.value	Telefonnummer des Benutzers. Datentyp: Zeichenfolge
bevorzugteSprache	Bevorzugte gesprochene und geschriebene Sprache des Benutzers. Datentyp: Zeichenfolge
-Schemata	Liste der URIs der SCIM-Benutzerschemata, die zur Verarbeitung der Anforderung verwendet werden. Datentyp: Array von Zeichenfolgen
Feld	Zeitzone des Benutzers. Datentyp: Zeichenfolge
Titel	Titel des Benutzers, z. B. CEO oder President. Datentyp: Zeichenfolge
userName	Eindeutiger Benutzername für den zugeordneten Benutzer. Datentyp: Zeichenfolge
userType	Benutzertyp. Dieser Wert wird verwendet, um die Beziehung zwischen Organisation und Benutzer zu identifizieren. Dies kann ein beliebiger Wert sein, aber typische Werte können sein: Vertragsunternehmen Mitarbeiter Praktikanten Temp Extern Unbekannt Datentyp: Zeichenfolge

Erweiterungsparameter zurückgegeben

Name	Beschreibung
Unternehmen	Details zum zugeordneten Unternehmen des Benutzers. Datentyp: Objekt "company": { "display": "String", "value": "String", "$ref": "String" }
unternehmen.anzeigen	Name des Unternehmens. Datentyp: Zeichenfolge
unternehmen.wert	Sys_id des Unternehmensdatensatzes. Datentyp: Zeichenfolge
Unternehmen.$ref	Referenz-URI für das Unternehmen. Datentyp: Zeichenfolge
costCenter	Details zur zugeordneten Kostenstelle des Benutzers. Datentyp: Objekt "costCenter": { "display": "String", "value": "String", "$ref": "String" }
costCenter.display	Name der Kostenstelle. Datentyp: Zeichenfolge
costCenter.value	Sys_id des Kostenstellen-Datensatzes. Datentyp: Zeichenfolge
costCenter.$ref	Referenz-URI für die Kostenstelle. Datentyp: Zeichenfolge
department	Details zur zugeordneten Abteilung des Benutzers. 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
employeeNumber	Numerische oder alphanumerische Mitarbeiternummer. Datentyp: Zeichenfolge
Geschlecht	Geschlecht des Benutzers, z. B. männlich oder frau. Datentyp: Zeichenfolge
location	Details zum zugeordneten Standort des Benutzers. Datentyp: Objekt "location": { "display": "String", "value": "String", "$ref": "String" }
location.display	Name des Standorts. Datentyp: Zeichenfolge
location.value	Sys_id des Standortdatensatzes. Datentyp: Zeichenfolge
Standort.$ref	Referenz-URI für den Standort. Datentyp: Zeichenfolge
Manager	Details zum zugeordneten Manager des Benutzers. Datentyp: Objekt "manager": { "display": "String", "value": "String", "$ref": "String" }
manager.display	Name des Managers. Datentyp: Zeichenfolge
manager.value	Sys_id des Manager-Datensatzes. Datentyp: Zeichenfolge
manager.$ref	Referenz-URI für den Manager. Datentyp: Zeichenfolge

cURL-Anforderung

Das folgende Beispiel zeigt, wie Werte in einem Benutzerdatensatz 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 Benutzerdatensatz in der Benutzertabelle [sys_user] einer Instanz ServiceNow unter Verwendung des SCIM-Protokolls (System for Cross-Domain Identity Management).

Hinweis:

Die in der RFC7643-Spezifikation genannten Funktionen für Suche und Massenänderung werden von diesem Endpunkt nicht unterstützt.

URL-Format

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

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

Unterstützte Anforderungsparameter

Tabelle : 73. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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
attributes	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit dem Parameter excludedAttributes verwendet werden. Datentyp: Zeichenfolge Standard: Gibt alle Felder zurück, es sei denn, excludedAttributes ist angegeben.
ausgeschlossene 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 dem Parameter attributes verwendet werden. Datentyp: Zeichenfolge Standard: Keine Felder ausschließen.

Tabelle : 75. Anforderungstextparameter (XML oder JSON)

Name	Beschreibung
aktiv	Kennzeichnung, die angibt, ob der zugeordnete Benutzer in der Instanz ServiceNow aktiv ist. Mögliche Werte: true: Benutzer ist aktiv. false: Benutzer ist inaktiv. Datentyp: Boolesch
addresses	Details zur aktuellen Postanschrift des Benutzers. Datentyp: Objekt "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" }
adressen.land	Ländername. Datentyp: Zeichenfolge
adressen.ort	Stadt- oder Ortsname. Datentyp: Zeichenfolge
adressen.postalCode	Postleitzahl. Datentyp: Zeichenfolge
adressen.region	Bundesland oder Region. Datentyp: Zeichenfolge
adressen.straßeAdresse	Vollständige Adresse mit Straße und Hausnummer. Dies kann Hausnummer, Straßenname, Postfach und mehrzeilige erweiterte Adresseninformationen umfassen. Datentyp: Zeichenfolge
address.type	Typ der Adresse. Unterstützt derzeit nur Homepage. Datentyp: Zeichenfolge
displayName	Benutzeranzeigename. Dieser Wert wird automatisch generiert, indem die Felder name verkettet werden. Datentyp: Zeichenfolge
E-Mails	Liste der E-Mail-Accounts, die dem Benutzer zugeordnet sind. Datentyp: Array von Objekten "emails:" [ { "type": "String", "value": "String" } ]
emails.type	E-Mail-Typ des Benutzers. Unterstützt derzeit nur den Typ „Arbeit“. Datentyp: Zeichenfolge
emails.value	E-Mail-Adresse des Benutzers. Dies ist ein eindeutiger Schlüssel für den zugeordneten Benutzer. Datentyp: Zeichenfolge
externe ID	Eindeutiger Bezeichner, der dem Benutzer von der Entität zugewiesen wird, die ihn bereitstellt. Datentyp: Zeichenfolge
Name	Informationen zum Benutzernamen. Datentyp: Objekt "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" }
name.familiename	Familien- oder Nachname des Benutzers. Datentyp: Zeichenfolge
name.givenName	Vorname oder Vorname des Benutzers. Datentyp: Zeichenfolge
name.honorificPrefix	Der ehrenwerte Name oder Titel des Benutzers, z. B. Dr., Biskuit oder Freibar. Datentyp: Zeichenfolge
name.middle	Zweiter Vorname des Benutzers. Datentyp: Zeichenfolge
phoneNumbers	Liste der Telefonnummern, die dem Benutzer zugeordnet sind. Datentyp: Array von Objekten "phoneNumbers": [ { "type": "String", "value": "String" } ]
phoneNumbers.type	Typ der Telefonnummer. Mögliche Werte: Homepage Mobile Arbeit Datentyp: Zeichenfolge
phoneNumbers.value	Telefonnummer des Benutzers. Datentyp: Zeichenfolge
bevorzugteSprache	Bevorzugte gesprochene und geschriebene Sprache des Benutzers. Datentyp: Zeichenfolge
Feld	Zeitzone des Benutzers. Datentyp: Zeichenfolge
Titel	Titel des Benutzers, z. B. CEO oder President. Datentyp: Zeichenfolge
userName	Erforderlich. Eindeutiger Benutzername für den zugeordneten Benutzer. Datentyp: Zeichenfolge
userType	Benutzertyp. Dieser Wert wird verwendet, um die Beziehung zwischen Organisation und Benutzer zu identifizieren. Dies kann ein beliebiger Wert sein, aber typische Werte können sein: Vertragsunternehmen Mitarbeiter Praktikanten Temp Extern Unbekannt Datentyp: Zeichenfolge
Erweitertes Schema
Unternehmen	Details zum zugeordneten Unternehmen des Benutzers. Datentyp: Objekt "company": { "value": "String" }
unternehmen.wert	Erforderlich, wenn das Unternehmen in der Veröffentlichung enthalten ist. Sys_id des Unternehmensdatensatzes. Datentyp: Zeichenfolge
costCenter	Details zur zugeordneten Kostenstelle des Benutzers. Datentyp: Objekt "costCenter": { "value": "String" }
costCenter.value	Erforderlich, wenn costCenter im Beitrag enthalten ist. Sys_id des Kostenstellen-Datensatzes. Datentyp: Zeichenfolge
department	Details zur zugeordneten Abteilung des Benutzers. Datentyp: Objekt "department": { "value": "String" }
abteilung.wert	Erforderlich, wenn die Abteilung in der Veröffentlichung enthalten ist. Sys_id des Abteilungsdatensatzes. Datentyp: Zeichenfolge
employeeNumber	Numerische oder alphanumerische Mitarbeiternummer. Datentyp: Zeichenfolge
Geschlecht	Geschlecht des Benutzers, z. B. männlich oder frau. Datentyp: Zeichenfolge
location	Details zum zugeordneten Standort des Benutzers. Datentyp: Objekt "location": { "value": "String" }
location.value	Erforderlich, wenn der Standort im Beitrag enthalten ist. Sys_id des Standortdatensatzes. Datentyp: Zeichenfolge
Manager	Details zum zugeordneten Manager des Benutzers. Datentyp: Objekt "manager": { "value": "String" }
manager.value	Erforderlich, wenn der Manager in der Veröffentlichung enthalten ist. Sys_id des Manager-Datensatzes. 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/json oder application/scim+json. Standard: application/json
Content-Type	Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder 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 HTTP-Antwortcodesder REST-API.

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. Der Parameter userName muss eindeutig sein.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Antworttextparameter (JSON oder XML)

Name	Beschreibung
aktiv	Kennzeichnung, die angibt, ob der zugeordnete Benutzer in der Instanz ServiceNow aktiv ist. Mögliche Werte: true: Benutzer ist aktiv. false: Benutzer ist inaktiv. Datentyp: Boolesch
addresses	Details zur aktuellen Postanschrift des Benutzers. Datentyp: Objekt "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" }
adressen.land	Ländername. Datentyp: Zeichenfolge
adressen.ort	Stadt- oder Ortsname. Datentyp: Zeichenfolge
adressen.postalCode	Postleitzahl. Datentyp: Zeichenfolge
adressen.region	Bundesland oder Region. Datentyp: Zeichenfolge
adressen.straßeAdresse	Vollständige Adresse mit Straße und Hausnummer. Dies kann Hausnummer, Straßenname, Postfach und mehrzeilige erweiterte Adresseninformationen umfassen. Datentyp: Zeichenfolge
address.type	Typ der Adresse. Unterstützt derzeit nur Homepage. Datentyp: Zeichenfolge
displayName	Benutzeranzeigename. Dieser Wert wird automatisch generiert, indem die Felder name verkettet werden. Datentyp: Zeichenfolge
E-Mails	Liste der E-Mail-Accounts, die dem Benutzer zugeordnet sind. Datentyp: Array von Objekten "emails:" [ { "type": "String", "value": "String" } ]
emails.type	E-Mail-Typ des Benutzers. Unterstützt derzeit nur den Typ „Arbeit“. Datentyp: Zeichenfolge
emails.value	E-Mail-Adresse des Benutzers. Dies ist ein eindeutiger Schlüssel für den zugeordneten Benutzer. 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" }
Fehler.detail	Detaillierte Fehlermeldung, warum die Anforderung fehlgeschlagen ist. Datentyp: Zeichenfolge
Fehler.scimType	SCIM-Fehlerdetail-Schlüsselwort. Datentyp: Zeichenfolge
Fehler.Schemata	URI der SCIM-Schemata, die zur Verarbeitung der Fehlerantwort verwendet werden. Datentyp: Array von Zeichenfolgen
Fehler.Status	HTTP-Statuscode für die Fehlerantwort. Datentyp: Zeichenfolge
externe ID	Eindeutiger Bezeichner, der dem Benutzer von der Entität zugewiesen wird, die ihn bereitstellt. Datentyp: Zeichenfolge
groups	Liste der Gruppen, denen der Benutzer angehört, entweder durch direkte Mitgliedschaft, verschachtelte Gruppen oder dynamisch berechnet. Datentyp: Array von Objekten "groups": [ { "display": "String", "type": "String", "value": "String", "$ref": "String" } ]
groups.display	Name der zugeordneten Gruppe. Datentyp: Zeichenfolge
groups.type	Typ der Gruppenzuordnung, z. B. direkt oder indirekt. Datentyp: Zeichenfolge
groups.value	Sys_id eines zugeordneten Gruppendatensatzes. Datentyp: Zeichenfolge
Gruppen.$ref	URI der zugeordneten Gruppe. Datentyp: Zeichenfolge
id	Sys_id des zugeordneten Benutzerdatensatzes. Datentyp: Zeichenfolge
meta	Metadaten, die sich auf den Benutzer beziehen. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
meta.created	Datum und Uhrzeit der Erstellung des Benutzerdatensatzes. Datentyp: Zeichenfolge
meta.lastModified	Datum und Uhrzeit der letzten Änderung des Benutzerdatensatzes. Datentyp: Zeichenfolge
meta.location	URI des abgerufenen Benutzers. Datentyp: Zeichenfolge
meta.resourceType	Ressourcentyp des SCIM-Anwenders Datentyp: Zeichenfolge
Name	Informationen zum Benutzernamen. Datentyp: Objekt "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" }
name.familiename	Familien- oder Nachname des Benutzers. Datentyp: Zeichenfolge
name.givenName	Vorname oder Vorname des Benutzers. Datentyp: Zeichenfolge
name.honorificPrefix	Der ehrenwerte Name oder Titel des Benutzers, z. B. Dr., Biskuit oder Freibar. Datentyp: Zeichenfolge
name.middle	Zweiter Vorname des Benutzers. Datentyp: Zeichenfolge
phoneNumbers	Liste der Telefonnummern, die dem Benutzer zugeordnet sind. Datentyp: Array von Objekten "phoneNumbers": [ { "type": "String", "value": "String" } ]
phoneNumbers.type	Typ der Telefonnummer. Mögliche Werte: Homepage Mobile Arbeit Datentyp: Zeichenfolge
phoneNumbers.value	Telefonnummer des Benutzers. Datentyp: Zeichenfolge
bevorzugteSprache	Bevorzugte gesprochene und geschriebene Sprache des Benutzers. Datentyp: Zeichenfolge
-Schemata	Liste der URIs der SCIM-Benutzerschemata, die zur Verarbeitung der Anforderung verwendet werden. Datentyp: Array von Zeichenfolgen
Feld	Zeitzone des Benutzers. Datentyp: Zeichenfolge
Titel	Titel des Benutzers, z. B. CEO oder President. Datentyp: Zeichenfolge
userName	Eindeutiger Benutzername für den zugeordneten Benutzer. Datentyp: Zeichenfolge
userType	Benutzertyp. Dieser Wert wird verwendet, um die Beziehung zwischen Organisation und Benutzer zu identifizieren. Dies kann ein beliebiger Wert sein, aber typische Werte können sein: Vertragsunternehmen Mitarbeiter Praktikanten Temp Extern Unbekannt Datentyp: Zeichenfolge

cURL-Anforderung an POST-Benutzer

Dieses Beispiel zeigt, wie der Benutzer „Jack Sperling“ per POST in die Benutzertabelle [sys_user] übertragen 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 Benutzerdatensatz in der Benutzertabelle [sys_user] einer Instanz ServiceNow mit dem SCIM-Protokoll (System for Cross-Domain Identity Management).

URL-Format

Versionierte URL: /api/now/{api_version}/scim/Users/{user_id}

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

Unterstützte Anforderungsparameter

Tabelle : 79. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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 Benutzerdatensatzes.

Tabelle : 80. Abfrageparameter

Name	Beschreibung
attributes	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit dem Parameter excludedAttributes verwendet werden. Datentyp: Zeichenfolge Standard: Gibt alle Felder zurück, es sei denn, excludedAttributes ist angegeben.
ausgeschlossene 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 dem Parameter attributes verwendet werden. Datentyp: Zeichenfolge Standard: Keine Felder ausschließen.

Tabelle : 81. Anforderungstextparameter (JSON)

Name	Beschreibung
aktiv	Kennzeichnung, die angibt, ob der zugeordnete Benutzer in der Instanz ServiceNow aktiv ist. Mögliche Werte: true: Benutzer ist aktiv. false: Benutzer ist inaktiv. Datentyp: Boolesch
addresses	Details zur aktuellen Postanschrift des Benutzers. Datentyp: Objekt "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" }
adressen.land	Ländername. Datentyp: Zeichenfolge
adressen.ort	Stadt- oder Ortsname. Datentyp: Zeichenfolge
adressen.postalCode	Postleitzahl. Datentyp: Zeichenfolge
adressen.region	Bundesland oder Region. Datentyp: Zeichenfolge
adressen.straßeAdresse	Vollständige Adresse mit Straße und Hausnummer. Dies kann Hausnummer, Straßenname, Postfach und mehrzeilige erweiterte Adresseninformationen umfassen. Datentyp: Zeichenfolge
address.type	Typ der Adresse. Unterstützt derzeit nur Homepage. Datentyp: Zeichenfolge
displayName	Benutzeranzeigename. Dieser Wert wird automatisch generiert, indem die Felder name verkettet werden. Datentyp: Zeichenfolge
E-Mails	Liste der E-Mail-Accounts, die dem Benutzer zugeordnet sind. Datentyp: Array von Objekten "emails:" [ { "type": "String", "value": "String" } ]
emails.type	E-Mail-Typ des Benutzers. Unterstützt derzeit nur den Typ „Arbeit“. Datentyp: Zeichenfolge
emails.value	E-Mail-Adresse des Benutzers. Dies ist ein eindeutiger Schlüssel für den zugeordneten Benutzer. Datentyp: Zeichenfolge
externe ID	Eindeutiger Bezeichner, der dem Benutzer von der Entität zugewiesen wird, die ihn bereitstellt. Datentyp: Zeichenfolge
Name	Informationen zum Benutzernamen. Datentyp: Objekt "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" }
name.familiename	Familien- oder Nachname des Benutzers. Datentyp: Zeichenfolge
name.givenName	Vorname oder Vorname des Benutzers. Datentyp: Zeichenfolge
name.honorificPrefix	Der ehrenwerte Name oder Titel des Benutzers, z. B. Dr., Biskuit oder Freibar. Datentyp: Zeichenfolge
name.middle	Zweiter Vorname des Benutzers. Datentyp: Zeichenfolge
phoneNumbers	Liste der Telefonnummern, die dem Benutzer zugeordnet sind. Datentyp: Array von Objekten "phoneNumbers": [ { "type": "String", "value": "String" } ]
phoneNumbers.type	Typ der Telefonnummer. Mögliche Werte: Homepage Mobile Arbeit Datentyp: Zeichenfolge
phoneNumbers.value	Telefonnummer des Benutzers. Datentyp: Zeichenfolge
bevorzugteSprache	Bevorzugte gesprochene und geschriebene Sprache des Benutzers. Datentyp: Zeichenfolge
Feld	Zeitzone des Benutzers. Datentyp: Zeichenfolge
Titel	Titel des Benutzers, z. B. CEO oder President. Datentyp: Zeichenfolge
userName	Erforderlich. Eindeutiger Benutzername für den zugeordneten Benutzer. Datentyp: Zeichenfolge
userType	Benutzertyp. Dieser Wert wird verwendet, um die Beziehung zwischen Organisation und Benutzer zu identifizieren. Dies kann ein beliebiger Wert sein, aber typische Werte können sein: Vertragsunternehmen Mitarbeiter Praktikanten Temp Extern Unbekannt Datentyp: Zeichenfolge
Erweitertes Schema
Unternehmen	Details zum zugeordneten Unternehmen des Benutzers. Datentyp: Objekt "company": { "value": "String" }
unternehmen.wert	Erforderlich, wenn das Unternehmen in der Veröffentlichung enthalten ist. Sys_id des Unternehmensdatensatzes. Datentyp: Zeichenfolge
costCenter	Details zur zugeordneten Kostenstelle des Benutzers. Datentyp: Objekt "costCenter": { "value": "String" }
costCenter.value	Erforderlich, wenn costCenter im Beitrag enthalten ist. Sys_id des Kostenstellen-Datensatzes. Datentyp: Zeichenfolge
department	Details zur zugeordneten Abteilung des Benutzers. Datentyp: Objekt "department": { "value": "String" }
abteilung.wert	Erforderlich, wenn die Abteilung in der Veröffentlichung enthalten ist. Sys_id des Abteilungsdatensatzes. Datentyp: Zeichenfolge
employeeNumber	Numerische oder alphanumerische Mitarbeiternummer. Datentyp: Zeichenfolge
Geschlecht	Geschlecht des Benutzers, z. B. männlich oder frau. Datentyp: Zeichenfolge
location	Details zum zugeordneten Standort des Benutzers. Datentyp: Objekt "location": { "value": "String" }
location.value	Erforderlich, wenn der Standort im Beitrag enthalten ist. Sys_id des Standortdatensatzes. Datentyp: Zeichenfolge
Manager	Details zum zugeordneten Manager des Benutzers. Datentyp: Objekt "manager": { "value": "String" }
manager.value	Erforderlich, wenn der Manager in der Veröffentlichung enthalten ist. Sys_id des Manager-Datensatzes. 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/json oder application/scim+json. Standard: application/json
Content-Type	Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder 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 HTTP-Antwortcodesder REST-API.

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. Der Parameter userName 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 Benutzer in der Instanz ServiceNow aktiv ist. Mögliche Werte: true: Benutzer ist aktiv. false: Benutzer ist inaktiv. Datentyp: Boolesch
addresses	Details zur aktuellen Postanschrift des Benutzers. Datentyp: Objekt "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" }
adressen.land	Ländername. Datentyp: Zeichenfolge
adressen.ort	Stadt- oder Ortsname. Datentyp: Zeichenfolge
adressen.postalCode	Postleitzahl. Datentyp: Zeichenfolge
adressen.region	Bundesland oder Region. Datentyp: Zeichenfolge
adressen.straßeAdresse	Vollständige Adresse mit Straße und Hausnummer. Dies kann Hausnummer, Straßenname, Postfach und mehrzeilige erweiterte Adresseninformationen umfassen. Datentyp: Zeichenfolge
address.type	Typ der Adresse. Unterstützt derzeit nur Homepage. Datentyp: Zeichenfolge
displayName	Benutzeranzeigename. Dieser Wert wird automatisch generiert, indem die Felder name verkettet werden. Datentyp: Zeichenfolge
E-Mails	Liste der E-Mail-Accounts, die dem Benutzer zugeordnet sind. Datentyp: Array von Objekten "emails:" [ { "type": "String", "value": "String" } ]
emails.type	E-Mail-Typ des Benutzers. Unterstützt derzeit nur den Typ „Arbeit“. Datentyp: Zeichenfolge
emails.value	E-Mail-Adresse des Benutzers. Dies ist ein eindeutiger Schlüssel für den zugeordneten Benutzer. 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" }
Fehler.detail	Detaillierte Fehlermeldung, warum die Anforderung fehlgeschlagen ist. Datentyp: Zeichenfolge
Fehler.scimType	SCIM-Fehlerdetail-Schlüsselwort. Datentyp: Zeichenfolge
Fehler.Schemata	URI der SCIM-Schemata, die zur Verarbeitung der Fehlerantwort verwendet werden. Datentyp: Array von Zeichenfolgen
Fehler.Status	HTTP-Statuscode für die Fehlerantwort. Datentyp: Zeichenfolge
externe ID	Eindeutiger Bezeichner, der dem Benutzer von der Entität zugewiesen wird, die ihn bereitstellt. Datentyp: Zeichenfolge
groups	Liste der Gruppen, denen der Benutzer angehört, entweder durch direkte Mitgliedschaft, verschachtelte Gruppen oder dynamisch berechnet. Datentyp: Array von Objekten "groups": [ { "display": "String", "type": "String", "value": "String", "$ref": "String" } ]
groups.display	Name der zugeordneten Gruppe. Datentyp: Zeichenfolge
groups.type	Typ der Gruppenzuordnung, z. B. direkt oder indirekt. Datentyp: Zeichenfolge
groups.value	Sys_id eines zugeordneten Gruppendatensatzes. Datentyp: Zeichenfolge
Gruppen.$ref	URI der zugeordneten Gruppe. Datentyp: Zeichenfolge
id	Sys_id des zugeordneten Benutzerdatensatzes. Datentyp: Zeichenfolge
meta	Metadaten, die sich auf den Benutzer beziehen. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
meta.created	Datum und Uhrzeit der Erstellung des Benutzerdatensatzes. Datentyp: Zeichenfolge
meta.lastModified	Datum und Uhrzeit der letzten Änderung des Benutzerdatensatzes. Datentyp: Zeichenfolge
meta.location	URI des abgerufenen Benutzers. Datentyp: Zeichenfolge
meta.resourceType	Ressourcentyp des SCIM-Anwenders Datentyp: Zeichenfolge
Name	Informationen zum Benutzernamen. Datentyp: Objekt "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" }
name.familiename	Familien- oder Nachname des Benutzers. Datentyp: Zeichenfolge
name.givenName	Vorname oder Vorname des Benutzers. Datentyp: Zeichenfolge
name.honorificPrefix	Der ehrenwerte Name oder Titel des Benutzers, z. B. Dr., Biskuit oder Freibar. Datentyp: Zeichenfolge
name.middle	Zweiter Vorname des Benutzers. Datentyp: Zeichenfolge
phoneNumbers	Liste der Telefonnummern, die dem Benutzer zugeordnet sind. Datentyp: Array von Objekten "phoneNumbers": [ { "type": "String", "value": "String" } ]
phoneNumbers.type	Typ der Telefonnummer. Mögliche Werte: Homepage Mobile Arbeit Datentyp: Zeichenfolge
phoneNumbers.value	Telefonnummer des Benutzers. Datentyp: Zeichenfolge
bevorzugteSprache	Bevorzugte gesprochene und geschriebene Sprache des Benutzers. Datentyp: Zeichenfolge
-Schemata	Liste der URIs der SCIM-Benutzerschemata, die zur Verarbeitung der Anforderung verwendet werden. Datentyp: Array von Zeichenfolgen
Feld	Zeitzone des Benutzers. Datentyp: Zeichenfolge
Titel	Titel des Benutzers, z. B. CEO oder President. Datentyp: Zeichenfolge
userName	Eindeutiger Benutzername für den zugeordneten Benutzer. Datentyp: Zeichenfolge
userType	Benutzertyp. Dieser Wert wird verwendet, um die Beziehung zwischen Organisation und Benutzer zu identifizieren. Dies kann ein beliebiger Wert sein, aber typische Werte können sein: Vertragsunternehmen Mitarbeiter Praktikanten Temp Extern Unbekannt Datentyp: Zeichenfolge

Erweiterungsparameter zurückgegeben

Name	Beschreibung
Unternehmen	Details zum zugeordneten Unternehmen des Benutzers. Datentyp: Objekt "company": { "display": "String", "value": "String", "$ref": "String" }
unternehmen.anzeigen	Name des Unternehmens. Datentyp: Zeichenfolge
unternehmen.wert	Sys_id des Unternehmensdatensatzes. Datentyp: Zeichenfolge
Unternehmen.$ref	Referenz-URI für das Unternehmen. Datentyp: Zeichenfolge
costCenter	Details zur zugeordneten Kostenstelle des Benutzers. Datentyp: Objekt "costCenter": { "display": "String", "value": "String", "$ref": "String" }
costCenter.display	Name der Kostenstelle. Datentyp: Zeichenfolge
costCenter.value	Sys_id des Kostenstellen-Datensatzes. Datentyp: Zeichenfolge
costCenter.$ref	Referenz-URI für die Kostenstelle. Datentyp: Zeichenfolge
department	Details zur zugeordneten Abteilung des Benutzers. 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
employeeNumber	Numerische oder alphanumerische Mitarbeiternummer. Datentyp: Zeichenfolge
Geschlecht	Geschlecht des Benutzers, z. B. männlich oder frau. Datentyp: Zeichenfolge
location	Details zum zugeordneten Standort des Benutzers. Datentyp: Objekt "location": { "display": "String", "value": "String", "$ref": "String" }
location.display	Name des Standorts. Datentyp: Zeichenfolge
location.value	Sys_id des Standortdatensatzes. Datentyp: Zeichenfolge
Standort.$ref	Referenz-URI für den Standort. Datentyp: Zeichenfolge
Manager	Details zum zugeordneten Manager des Benutzers. Datentyp: Objekt "manager": { "display": "String", "value": "String", "$ref": "String" }
manager.display	Name des Managers. Datentyp: Zeichenfolge
manager.value	Sys_id des Manager-Datensatzes. Datentyp: Zeichenfolge
manager.$ref	Referenz-URI für den Manager. Datentyp: Zeichenfolge

cURL-Anforderung zum Aktualisieren von Benutzerinformationen mit PUT

Dieses Beispiel zeigt, wie die Informationen eines vorhandenen Benutzers mit dem PUT-Endpunkt 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 – GET /scim/ResourceTypes

Ruft Informationen zu allen SCIM-Ressourcentypen (System for Cross-Domain Identity Management) ab, die von der zugeordneten Instanz ServiceNow unterstützt werden.

Dies ist ein öffentlicher Endpunkt, für den keine Rollen erforderlich sind.

URL-Format

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

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

Unterstützte Anforderungsparameter

Tabelle : 85. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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. Anforderungstextparameter (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/json oder 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 HTTP-Antwortcodesder REST-API.

Tabelle : 90. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
itemsProSeite	Anzahl der Datensätze, die in den Rückgabeergebnissen zurückgegeben werden. 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
Resources.endpoint	Name des über HTTP adressierbaren Endpunkts relativ zur Basis-URL des Service Providers, z. B. „Benutzer“. Datentyp: Zeichenfolge
Resources.id	Eindeutiger Identifier für die Ressource. Verwenden Sie dieses Attribut beim Aufrufen des Endpunkts GET /scim/ResourceType/{resource_id}. Datentyp: Zeichenfolge
Resources.meta	Informationen, die die zugeordnete Ressource weiter beschreiben. Datentyp: Objekt "metadata": { "location": "String", "resourceType": "String" }
Resources.meta.location	URI des zugeordneten Ressourcentyps in der zugeordneten Instanz ServiceNow. Datentyp: Zeichenfolge
Resources.meta.resourceType	Immer „ResourceType“. Datentyp: Zeichenfolge
Resources.name	Name des Ressourcentyps, z. B. Benutzer oder Gruppe. Datentyp: Zeichenfolge
Resources.schema	Primärer/Basisschema-URI des Ressourcentyps. Beispiel: "urn:ietf:params:scim:schemas:core:2.0:User". Datentyp: Zeichenfolge
Resources.schemas	Schema, das zur Verarbeitung der /ResourceType- Anforderung verwendet wird. Beispiel: "urn:ietf:params:scim:schemas:core:2.0:ResourceType". Datentyp: Zeichenfolge
Resources.schemaExtensions	Liste der Schemaerweiterungen, die für den zugeordneten Ressourcentyp gelten. Beispiel: "urn:ietf:params:scim:schemas:extension: servicenow:2.0:User". Datentyp: Array von Objekten "schemaExtensions": { "required": Boolean, "schema": "String" }
Resources.schemaExtensions.erforderlich	Kennzeichnung, die angibt, ob die Schemaerweiterung für den Ressourcentyp erforderlich ist. Mögliche Werte: true: Eine Ressource dieses Typs muss diese Schemaerweiterung und alle Attribute enthalten, die in dieser Schemaerweiterung als erforderlich deklariert wurden. false: Eine Ressource dieses Typs kann diese Schemaerweiterung auslassen. Datentyp: Boolesch
Resources.schemaExtensions.schema	URI eines erweiterten Schemas. Beispiel: "urn:ietf:params:scim:schemas:extension: servicenow:2.0:User". Datentyp: Zeichenfolge
-Schemata	Schema, das zur Verarbeitung der Listenantwort auf die Anforderung verwendet wird. Beispiel: "urn:ietf:params:scim:api:messages:2.0:ListResponse" Datentyp: Zeichenfolge
startIndex	Einbasierter Index in der Ressourcentabelle, in der Datensätze abgerufen wurden. Datentyp: Zeichenfolge
totalResults	Gesamtzahl der Datensätze, die der Anforderung entsprechen. Datentyp: Zahl

cURL-Anforderung

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

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 SCIM-Ressourcentyp (System for Cross-Domain Identity Management) ab.

Dies ist ein öffentlicher Endpunkt, für den keine Rollen erforderlich sind.

URL-Format

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

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

Unterstützte Anforderungsparameter

Tabelle : 91. Pfadparameter

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

Tabelle : 92. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 93. Anforderungstextparameter (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/json oder 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 HTTP-Antwortcodesder REST-API.

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 über HTTP adressierbaren Endpunkts relativ zur Basis-URL des Service Providers, z. B. „Unternehmen“. Datentyp: Zeichenfolge
id	Eindeutiger Identifier 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 in der zugeordneten Instanz ServiceNow. Datentyp: Zeichenfolge
meta.resourceType	Immer „ResourceType“. Datentyp: Zeichenfolge
Name	Name des Ressourcentyps, z. B. Benutzer oder Gruppe. Datentyp: Zeichenfolge
Schema	Primärer/Basisschema-URI des Ressourcentyps. Beispiel: "urn:ietf:params:scim:schemas:core:2.0:User". Datentyp: Zeichenfolge
-Schemata	Schema, das zur Verarbeitung der /ResourceType- Anforderung verwendet wird. Beispiel: "urn:ietf:params:scim:schemas:core:2.0:ResourceType". Datentyp: Zeichenfolge
schemaExtensions	Liste der Schemaerweiterungen, die für den zugeordneten Ressourcentyp gelten. Beispiel: "urn:ietf:params:scim:schemas:extension: servicenow:2.0:User". Datentyp: Array von Objekten "schemaExtensions": { "required": Boolean, "schema": "String" }
schemaExtensions.required	Kennzeichnung, die angibt, ob die Schemaerweiterung für den Ressourcentyp erforderlich ist. Mögliche Werte: true: Eine Ressource dieses Typs muss diese Schemaerweiterung und alle Attribute enthalten, die in dieser Schemaerweiterung als erforderlich deklariert wurden. false: Eine Ressource dieses Typs kann diese Schemaerweiterung auslassen. Datentyp: Boolesch
schemaExtensions.schema	URI eines erweiterten Schemas. Beispiel: "urn:ietf:params:scim:schemas:extension: servicenow:2.0:User". Datentyp: Zeichenfolge
-Schemata	Schema, das zur Verarbeitung der Listenantwort auf die Anforderung verwendet wird. Beispiel: "urn:ietf:params:scim:api:messages:2.0:ListResponse" Datentyp: Zeichenfolge

cURL-Anforderung

Das folgende Beispiel zeigt, wie der Ressourcentyp Benutzer-SCIM aus einer ServiceNow -Instanz abgerufen wird.

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 – GET /scim/Schemas

Ruft Informationen zu allen SCIM-Ressourcenschemas (System for Cross-Domain Identity Management) ab, die von einer ServiceNow -Instanz unterstützt werden. Diese Schemas definieren die für jeden Ressourcentyp verfügbaren Attribute.

Dies ist ein öffentlicher Endpunkt, für den keine Rollen erforderlich sind.

URL-Format

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

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

Unterstützte Anforderungsparameter

Tabelle : 97. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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. Anforderungstextparameter (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/json oder 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 HTTP-Antwortcodesder REST-API.

Tabelle : 102. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.

Parameter des Antwort-Haupttexts (JSON)

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

cURL-Anforderung

Das folgende Beispiel zeigt, wie Sie die von einer ServiceNow -Instanz unterstützten SCIM-Schemata erhalten.

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 – GET /scim/Schemas/{SchemaName}

Ruft Informationen über das angegebene System für SCIM-Ressourcenschemas (Cross-Domain Identity Management) ab, das von einer ServiceNow -Instanz unterstützt wird. Diese Schemas definieren die für jeden Ressourcentyp verfügbaren Attribute.

Dies ist ein öffentlicher Endpunkt, für den keine Rollen erforderlich sind.

URL-Format

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

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

Unterstützte Anforderungsparameter

Tabelle : 103. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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:Benutzer 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. Anforderungstextparameter (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/json oder 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 HTTP-Antwortcodesder REST-API.

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-Rückgabeergebnisse	Die Methode gibt Ergebnisse zurück, die dem RFC7643-Standard entsprechen. Weitere Informationen finden Sie unter Schemadefinition in der RFC7643-Spezifikation.

cURL-Anforderung

Das folgende Beispiel zeigt, wie das SCIM-Kernschema der Gruppe aus einer ServiceNow -Instanz abgerufen wird.

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 zum Abrufen von Informationen über die Servicefähigkeiten, Konfigurationen, Schemas und Ressourcentypen für die SCIM-Endpunkte (System for Cross-Domain Identity Management) verwendet werden sollen, die in einer ServiceNow -Instanz verfügbar sind.

Dies ist ein öffentlicher Endpunkt, für den keine Rollen erforderlich sind.

URL-Format

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

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

Unterstützte Anforderungsparameter

Tabelle : 109. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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. Anforderungstextparameter (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/json oder 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 HTTP-Antwortcodesder REST-API.

Tabelle : 114. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
Standard-RFC7643-Rückgabeergebnisse	Die Methode gibt Ergebnisse zurück, die dem RFC7643-Standard entsprechen. Weitere Informationen finden Sie unter Service Provider-Konfigurationsschema in der RFC7643-Spezifikation.

cURL-Anforderung

Das folgende Beispiel zeigt, wie die SCIM-Konfigurationsmetadaten für eine ServiceNow -Instanz abgerufen werden.

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 einer Instanz ServiceNow zurück, wobei das SCIM-Protokoll (System for Cross-Domain Identity Management) verwendet wird.

Hinweis:

Eine Abfrage, die keine Übereinstimmungen zurückgibt, gibt „Success“ (HTTP-Statuscode 200) zurück, wobei totalResults auf 0 festgelegt ist.

URL-Format

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

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

Unterstützte Anforderungsparameter

Tabelle : 115. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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
attributes	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit dem Parameter excludedAttributes verwendet werden. Datentyp: Zeichenfolge Standard: Gibt alle Felder zurück, es sei denn, excludedAttributes ist angegeben.
count	Anzahl der zurückzugebenden Datensätze. Ein negativer Wert wird als Null interpretiert. Datentyp: Zahl Maximum: 500 – Ein größerer Wert führt zu einem Fehler bei der Anforderung. Standard: 10
ausgeschlossene 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 dem Parameter attributes verwendet werden. Datentyp: Zeichenfolge Standard: Keine Felder ausschließen.
filter	Filterausdruck, der auf die zurückgegebenen Ergebnisse angewendet werden soll. Feldfilter werden ausgedrückt als<field_name><operator> <"Wert">. Unter RFC7644 finden Sie eine Liste der gültigen Operatoren. Hinweis: Der NOT- Operator wird von dieser Methode nicht unterstützt. Um beispielsweise nach allen Unternehmen zu filtern, deren Name mit „Acme“ beginnt, geben Sie displayName SW „Acme“ein. Um mehr als einen Feldfilter anzugeben, verketten Sie die Filter mit dem AND- Operanden. Um beispielsweise nach allen Unternehmen zu filtern, deren Name mit „Acme“ beginnt und die zuletzt vor dem 3. Oktober 2021 geändert wurden, geben Sie displayName SW „Acme“ AND meta.lastModified lt „2021-10-03T00:00:00Z“ ein. Verwenden Sie Dot-Walking, um verschachtelte Attribute anzugeben. Datentyp: Zeichenfolge Standard: Keine Filterung
sortBy	Muss mit dem Parameter sortOrder angegeben werden. Feld, nach dem die zurückgegebenen Ergebnisse sortiert werden sollen. Bei der Sortierung wird die Groß-/Kleinschreibung beachtet. Sie können nur die Parameter verwenden, die für die Filterung nach dem Parameter sortBy verfügbar sind, mit der Ausnahme, dass externalId nicht zulässig ist. Für Werte, die null sind: Sortiert nach aufsteigend: Nullwerte werden nach oben sortiert. Sortiert nach absteigend: Nullwerte werden nach unten sortiert. Datentyp: Zeichenfolge Standard: Keine Sortierung
sortOrder	Muss mit dem Parameter sortBy angegeben werden. Reihenfolge, in der der Parameter sortBy auf die Rückgabeergebnisse angewendet wird. Gültige Werte: Aufsteigend Absteigend Datentyp: Zeichenfolge Standard: aufsteigend
startIndex	Einbasierter Index in der Tabelle, ab der mit dem Abrufen von Datensätzen begonnen werden soll. Wenn Sie diesen Parameter beispielsweise auf 100 und den Parameter count auf 20 festlegen, gibt der Endpunkt die Datensätze 100 bis 119 zurück. Hinweis: Jeder Wert, der auf weniger als eins festgelegt ist, wird als eins interpretiert. Datentyp: Zeichenfolge Standard: 1

Tabelle : 117. Anforderungstextparameter (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/json oder 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 HTTP-Antwortcodesder REST-API.

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 die Abfrageparameter attributes und excludedAttributes nicht in der Anforderung übergeben wurden. Stellen Sie sicher, dass der Parameter count nicht größer als 500 ist. Stellen Sie sicher, dass alle Parameter filter gültig sind.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
itemsProSeite	Anzahl der Datensätze, die in den Rückgabeergebnissen zurückgegeben werden. Datentyp: Zahl
Ressourcen	Liste der zurückgegebenen Kostenstellendatensätze. Datentyp: Objekt "Resources": { "id": "String", "meta": {Object}, "name": "String", "schemas": "String" }
Resources.id	Sys_id des Unternehmensdatensatzes. Datentyp: Zeichenfolge
Resources.meta	Informationen zum Unternehmensdatensatz. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" }
Resources.meta.created	Datum und Uhrzeit der Erstellung des zugeordneten Unternehmensdatensatzes. Datentyp: Zeichenfolge
Resources.meta.lastModified	Datum und Uhrzeit der letzten Änderung des zugeordneten Unternehmensdatensatzes. Datentyp: Zeichenfolge
Resources.meta.location	URI des zugeordneten Unternehmensdatensatzes. Datentyp: Zeichenfolge
Resources.meta.resourceType	SCIM-Ressourcentyp; immer Unternehmen. Datentyp: Zeichenfolge
Resources.name	Unternehmensname. Datentyp: Zeichenfolge
Resources.schemas	Bei der Verarbeitung der Anforderung verwendetes Schema. Datentyp: Zeichenfolge
-Schemata	Schema, das zur Verarbeitung der Listenantwort auf die Anforderung verwendet wird. Beispiel: "urn:ietf:params:scim:api:messages:2.0:ListResponse" Datentyp: Zeichenfolge
startIndex	Einbasierter Index in der Tabelle „Unternehmen“ [core_company], an der die Datensätze zurückgegeben wurden. Datentyp: Zeichenfolge
totalResults	Gesamtzahl 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 einer Instanz ServiceNow unter Verwendung des SCIM-Protokolls (System for Cross-Domain Identity Management) zurück.

URL-Format

Versionierte URL: /api/now/{api_version}/scim/Companies/{company_id}

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

Unterstützte Anforderungsparameter

Tabelle : 121. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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
attributes	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit dem Parameter excludedAttributes verwendet werden. Datentyp: Zeichenfolge Standard: Gibt alle Felder zurück, es sei denn, excludedAttributes ist angegeben.
ausgeschlossene 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 dem Parameter attributes verwendet werden. Datentyp: Zeichenfolge Standard: Keine Felder ausschließen.

Tabelle : 123. Anforderungstextparameter (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/json oder 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 HTTP-Antwortcodesder REST-API.

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 die Abfrageparameter attributes und excludedAttributes nicht in der Anforderung übergeben wurden. Stellen Sie sicher, dass der Parameter count nicht größer als 500 ist. Stellen Sie sicher, dass alle Parameter filter gültig sind.
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.created	Datum und Uhrzeit der Erstellung des zugeordneten Unternehmensdatensatzes. Datentyp: Zeichenfolge
meta.lastModified	Datum und Uhrzeit der letzten Änderung des zugeordneten Unternehmensdatensatzes. Datentyp: Zeichenfolge
meta.location	URI des zugeordneten Unternehmensdatensatzes. Datentyp: Zeichenfolge
meta.resourceType	SCIM-Ressourcentyp; immer Unternehmen. Datentyp: Zeichenfolge
Name	Unternehmensname. Datentyp: Zeichenfolge
-Schemata	Bei der Verarbeitung der Anforderung verwendetes Schema. 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 – GET /scim/CostCenters

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

Hinweis:

Eine Abfrage, die keine Übereinstimmungen zurückgibt, gibt „Success“ (HTTP-Statuscode 200) zurück, wobei totalResults auf 0 festgelegt ist.

URL-Format

Versionierte URL: /api/now/{api_version}/scim/CostCenters

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

Unterstützte Anforderungsparameter

Tabelle : 127. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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
attributes	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit dem Parameter excludedAttributes verwendet werden. Datentyp: Zeichenfolge Standard: Gibt alle Felder zurück, es sei denn, excludedAttributes ist angegeben.
count	Anzahl der zurückzugebenden Datensätze. Ein negativer Wert wird als Null interpretiert. Datentyp: Zahl Maximum: 500 – Ein größerer Wert führt zu einem Fehler bei der Anforderung. Standard: 10
ausgeschlossene 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 dem Parameter attributes verwendet werden. Datentyp: Zeichenfolge Standard: Keine Felder ausschließen.
filter	Filterausdruck, der auf die zurückgegebenen Ergebnisse angewendet werden soll. Feldfilter werden ausgedrückt als<field_name><operator> <"Wert">. Unter RFC7644 finden Sie eine Liste der gültigen Operatoren. Hinweis: Der NOT- Operator wird von dieser Methode nicht unterstützt. Um beispielsweise nach allen Kostenstellen zu filtern, deren Name mit „HR“ beginnt, geben Sie displayName SW „HR“ein. Um mehr als einen Feldfilter anzugeben, verketten Sie die Filter mit dem AND- Operanden. Um beispielsweise nach allen Kostenstellen zu filtern, deren Name mit „HR“ beginnt und die zuletzt vor dem 3. Oktober 2021 geändert wurden, geben Sie displayName SW „HR“ AND meta.lastModified lt „2021-10-03T00:00:00Z“ ein. Verwenden Sie Dot-Walking, um verschachtelte Attribute anzugeben. Datentyp: Zeichenfolge Standard: Keine Filterung
sortBy	Muss mit dem Parameter sortOrder angegeben werden. Feld, nach dem die zurückgegebenen Ergebnisse sortiert werden sollen. Bei der Sortierung wird die Groß-/Kleinschreibung beachtet. Sie können nur die Parameter verwenden, die für die Filterung nach dem Parameter sortBy verfügbar sind, mit der Ausnahme, dass externalId nicht zulässig ist. Für Werte, die null sind: Sortiert nach aufsteigend: Nullwerte werden nach oben sortiert. Sortiert nach absteigend: Nullwerte werden nach unten sortiert. Datentyp: Zeichenfolge Standard: Keine Sortierung
sortOrder	Muss mit dem Parameter sortBy angegeben werden. Reihenfolge, in der der Parameter sortBy auf die Rückgabeergebnisse angewendet wird. Gültige Werte: Aufsteigend Absteigend Datentyp: Zeichenfolge Standard: aufsteigend
startIndex	Einbasierter Index in der Tabelle, ab der mit dem Abrufen von Datensätzen begonnen werden soll. Wenn Sie diesen Parameter beispielsweise auf 100 und den Parameter count auf 20 festlegen, gibt der Endpunkt die Datensätze 100 bis 119 zurück. Hinweis: Jeder Wert, der auf weniger als eins festgelegt ist, wird als eins interpretiert. Datentyp: Zeichenfolge Standard: 1

Tabelle : 129. Anforderungstextparameter (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/json oder 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 HTTP-Antwortcodesder REST-API.

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 die Abfrageparameter attributes und excludedAttributes nicht in der Anforderung übergeben wurden. Stellen Sie sicher, dass der Parameter count nicht größer als 500 ist. Stellen Sie sicher, dass alle Parameter filter gültig sind.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
itemsProSeite	Anzahl der Datensätze, die in den Rückgabeergebnissen zurückgegeben werden. Datentyp: Zahl
Ressourcen	Liste der zurückgegebenen Kostenstellendatensätze. Datentyp: Objekt "Resources": { "id": "String", "meta": {Object}, "name": "String", "schemas": "String" }
Resources.id	Sys_id des Kostenstellen-Datensatzes. Datentyp: Zeichenfolge
Resources.meta	Informationen zum Kostenstellendatensatz. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" }
Resources.meta.created	Datum und Uhrzeit der Erstellung des zugeordneten Kostenstellen-Datensatzes. Datentyp: Zeichenfolge
Resources.meta.lastModified	Zeitpunkt (Datum und Uhrzeit), zu dem der zugeordnete Kostenstellen-Datensatz zuletzt geändert wurde. Datentyp: Zeichenfolge
Resources.meta.location	URI des zugeordneten Kostenstellen-Datensatzes. Datentyp: Zeichenfolge
Resources.meta.resourceType	SCIM-Ressourcentyp; Immer Kostenstelle. Datentyp: Zeichenfolge
Resources.name	Name der Kostenstelle. Datentyp: Zeichenfolge
Resources.schemas	Bei der Verarbeitung der Anforderung verwendetes Schema. Datentyp: Zeichenfolge
-Schemata	Schema, das zur Verarbeitung der Listenantwort auf die Anforderung verwendet wird. Beispiel: "urn:ietf:params:scim:api:messages:2.0:ListResponse" Datentyp: Zeichenfolge
startIndex	Einbasierter Index in der Tabelle „Kostenstelle“ [cmn_cost_center], an der die Datensätze zurückgegeben wurden. Datentyp: Zeichenfolge
totalResults	Gesamtzahl 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 einer Instanz ServiceNow unter Verwendung des SCIM-Protokolls (System for Cross-Domain Identity Management) zurück.

Hinweis:

Eine Abfrage, die keine Übereinstimmungen zurückgibt, gibt „Success“ (HTTP-Statuscode 200) zurück, wobei totalResults auf 0 festgelegt ist.

URL-Format

Versionierte URL: /api/now/{api_version}/scim/CostCenters/{cost_center_id}

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

Unterstützte Anforderungsparameter

Tabelle : 133. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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
attributes	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit dem Parameter excludedAttributes verwendet werden. Datentyp: Zeichenfolge Standard: Gibt alle Felder zurück, es sei denn, excludedAttributes ist angegeben.
ausgeschlossene 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 dem Parameter attributes verwendet werden. Datentyp: Zeichenfolge Standard: Keine Felder ausschließen.

Tabelle : 135. Anforderungstextparameter (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/json oder 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 HTTP-Antwortcodesder REST-API.

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 die Abfrageparameter attributes und excludedAttributes nicht in der Anforderung übergeben wurden. Stellen Sie sicher, dass der Parameter count nicht größer als 500 ist. Stellen Sie sicher, dass alle Parameter filter gültig sind.
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 Kostenstellen-Datensatzes. Datentyp: Zeichenfolge
meta	Informationen zum Kostenstellendatensatz. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" }
meta.created	Datum und Uhrzeit der Erstellung des zugeordneten Kostenstellen-Datensatzes. Datentyp: Zeichenfolge
meta.lastModified	Zeitpunkt (Datum und Uhrzeit), zu dem der zugeordnete Kostenstellen-Datensatz zuletzt geändert wurde. Datentyp: Zeichenfolge
meta.location	URI des zugeordneten Kostenstellen-Datensatzes. Datentyp: Zeichenfolge
meta.resourceType	SCIM-Ressourcentyp; Immer Kostenstelle. Datentyp: Zeichenfolge
Name	Name der Kostenstelle. Datentyp: Zeichenfolge
-Schemata	Bei der Verarbeitung der Anforderung verwendetes Schema. 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 einer Instanz ServiceNow zurück, wobei das SCIM-Protokoll (System for Cross-Domain Identity Management) verwendet wird.

Hinweis:

Eine Abfrage, die keine Übereinstimmungen zurückgibt, gibt „Success“ (HTTP-Statuscode 200) zurück, wobei totalResults auf 0 festgelegt ist.

URL-Format

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

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

Unterstützte Anforderungsparameter

Tabelle : 139. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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
attributes	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit dem Parameter excludedAttributes verwendet werden. Datentyp: Zeichenfolge Standard: Gibt alle Felder zurück, es sei denn, excludedAttributes ist angegeben.
count	Anzahl der zurückzugebenden Datensätze. Ein negativer Wert wird als Null interpretiert. Datentyp: Zahl Maximum: 500 – Ein größerer Wert führt zu einem Fehler bei der Anforderung. Standard: 10
ausgeschlossene 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 dem Parameter attributes verwendet werden. Datentyp: Zeichenfolge Standard: Keine Felder ausschließen.
filter	Filterausdruck, der auf die zurückgegebenen Ergebnisse angewendet werden soll. Feldfilter werden ausgedrückt als<field_name><operator> <"Wert">. Unter RFC7644 finden Sie eine Liste der gültigen Operatoren. Hinweis: Der NOT- Operator wird von dieser Methode nicht unterstützt. Um beispielsweise nach allen Abteilungen zu filtern, deren Name mit „Ingenieur“ beginnt, geben Sie displayName SW „Ingenieur“ein. Um mehr als einen Feldfilter anzugeben, verketten Sie die Filter mit dem AND- Operanden. Um beispielsweise nach allen Abteilungen zu filtern, deren Name mit „Engineer“ beginnt und die zuletzt vor dem 3. Oktober 2021 geändert wurden, geben Sie displayName SW „Engineer“ AND meta.lastModified lt „2021-10-03T00:00:00Z“ ein. Verwenden Sie Dot-Walking, um verschachtelte Attribute anzugeben. Datentyp: Zeichenfolge Standard: Keine Filterung
sortBy	Muss mit dem Parameter sortOrder angegeben werden. Feld, nach dem die zurückgegebenen Ergebnisse sortiert werden sollen. Bei der Sortierung wird die Groß-/Kleinschreibung beachtet. Sie können nur die Parameter verwenden, die für die Filterung nach dem Parameter sortBy verfügbar sind, mit der Ausnahme, dass externalId nicht zulässig ist. Für Werte, die null sind: Sortiert nach aufsteigend: Nullwerte werden nach oben sortiert. Sortiert nach absteigend: Nullwerte werden nach unten sortiert. Datentyp: Zeichenfolge Standard: Keine Sortierung
sortOrder	Muss mit dem Parameter sortBy angegeben werden. Reihenfolge, in der der Parameter sortBy auf die Rückgabeergebnisse angewendet wird. Gültige Werte: Aufsteigend Absteigend Datentyp: Zeichenfolge Standard: aufsteigend
startIndex	Einbasierter Index in der Tabelle, ab der mit dem Abrufen von Datensätzen begonnen werden soll. Wenn Sie diesen Parameter beispielsweise auf 100 und den Parameter count auf 20 festlegen, gibt der Endpunkt die Datensätze 100 bis 119 zurück. Hinweis: Jeder Wert, der auf weniger als eins festgelegt ist, wird als eins interpretiert. Datentyp: Zeichenfolge Standard: 1

Tabelle : 141. Anforderungstextparameter (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/json oder 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 HTTP-Antwortcodesder REST-API.

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 die Abfrageparameter attributes und excludedAttributes nicht in der Anforderung übergeben wurden. Stellen Sie sicher, dass der Parameter count nicht größer als 500 ist. Stellen Sie sicher, dass alle Parameter filter gültig sind.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
itemsProSeite	Anzahl der Datensätze, die in den Rückgabeergebnissen zurückgegeben werden. Datentyp: Zahl
Ressourcen	Liste der zurückgegebenen Abteilungsdatensätze. Datentyp: Objekt "Resources": { "id": "String", "meta": {Object}, "name": "String", "schemas": "String" }
Resources.id	Sys_id des Abteilungsdatensatzes. Datentyp: Zeichenfolge
Resources.meta	Informationen zum Abteilungsdatensatz. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" }
Resources.meta.created	Datum und Uhrzeit der Erstellung des zugeordneten Abteilungsdatensatzes. Datentyp: Zeichenfolge
Resources.meta.lastModified	Datum und Uhrzeit, zu der der zugeordnete Abteilungsdatensatz zuletzt geändert wurde. Datentyp: Zeichenfolge
Resources.meta.location	URI des zugeordneten Abteilungsdatensatzes. Datentyp: Zeichenfolge
Resources.meta.resourceType	SCIM-Ressourcentyp; immer Abteilung. Datentyp: Zeichenfolge
Resources.name	Abteilungsname. Datentyp: Zeichenfolge
Resources.schemas
-Schemata
startIndex	Einbasierter Index in der Tabelle „Abteilung“ [cmn_department], an der die Datensätze zurückgegeben wurden. Datentyp: Zeichenfolge
totalResults	Gesamtzahl 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 einer Instanz ServiceNow unter Verwendung des SCIM-Protokolls (System for Cross-Domain Identity Management) zurück.

URL-Format

Versionierte URL: /api/now/{api_version}/scim/Departments/{department_id}

Standard-URL: /api/now/scim/Departments/{department_id}

Unterstützte Anforderungsparameter

Tabelle : 145. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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
attributes	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit dem Parameter excludedAttributes verwendet werden. Datentyp: Zeichenfolge Standard: Gibt alle Felder zurück, es sei denn, excludedAttributes ist angegeben.
ausgeschlossene 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 dem Parameter attributes verwendet werden. Datentyp: Zeichenfolge Standard: Keine Felder ausschließen.

Tabelle : 147. Anforderungstextparameter (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/json oder 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 HTTP-Antwortcodesder REST-API.

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 die Abfrageparameter attributes und excludedAttributes nicht in der Anforderung übergeben wurden. Stellen Sie sicher, dass der Parameter count nicht größer als 500 ist. Stellen Sie sicher, dass alle Parameter filter gültig sind.
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.created	Datum und Uhrzeit der Erstellung des zugeordneten Abteilungsdatensatzes. Datentyp: Zeichenfolge
meta.lastModified	Datum und Uhrzeit, zu der der zugeordnete Abteilungsdatensatz zuletzt geändert wurde. Datentyp: Zeichenfolge
meta.location	URI des zugeordneten Abteilungsdatensatzes. Datentyp: Zeichenfolge
meta.resourceType	SCIM-Ressourcentyp; immer Abteilung. Datentyp: Zeichenfolge
Name	Abteilungsname. Datentyp: Zeichenfolge
-Schemata	Bei der Verarbeitung der Anforderung verwendetes Schema. 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 – GET /scim/Locations

Gibt einen oder mehrere Standortdatensätze aus der Standorttabelle [cmn_location] innerhalb einer ServiceNow -Instanz unter Verwendung des SCIM-Protokolls (System for Cross-Domain Identity Management) zurück.

Hinweis:

Eine Abfrage, die keine Übereinstimmungen zurückgibt, gibt „Success“ (HTTP-Statuscode 200) zurück, wobei totalResults auf 0 festgelegt ist.

URL-Format

Versionierte URL: /api/now/{api_version}/scim/Locations

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

Unterstützte Anforderungsparameter

Tabelle : 151. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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
attributes	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit dem Parameter excludedAttributes verwendet werden. Datentyp: Zeichenfolge Standard: Gibt alle Felder zurück, es sei denn, excludedAttributes ist angegeben.
count	Anzahl der zurückzugebenden Datensätze. Ein negativer Wert wird als Null interpretiert. Datentyp: Zahl Maximum: 500 – Ein größerer Wert führt zu einem Fehler bei der Anforderung. Standard: 10
ausgeschlossene 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 dem Parameter attributes verwendet werden. Datentyp: Zeichenfolge Standard: Keine Felder ausschließen.
filter	Filterausdruck, der auf die zurückgegebenen Ergebnisse angewendet werden soll. Feldfilter werden ausgedrückt als<field_name><operator> <"Wert">. Unter RFC7644 finden Sie eine Liste der gültigen Operatoren. Hinweis: Der NOT- Operator wird von dieser Methode nicht unterstützt. Um beispielsweise nach allen Standorten zu filtern, deren Name mit „Ch“ beginnt, geben Sie displayName SW „Ch“ein. Um mehr als einen Feldfilter anzugeben, verketten Sie die Filter mit dem AND- Operanden. Um beispielsweise nach allen Standorten zu filtern, deren Name mit „Ch“ beginnt und die zuletzt vor dem 3. Oktober 2021 geändert wurden, geben Sie displayName SW „Ch“ UND meta.lastModified lt „2021-10-03T00:00:00Z“ ein. Verwenden Sie Dot-Walking, um verschachtelte Attribute anzugeben. Datentyp: Zeichenfolge Standard: Keine Filterung
sortBy	Muss mit dem Parameter sortOrder angegeben werden. Feld, nach dem die zurückgegebenen Ergebnisse sortiert werden sollen. Bei der Sortierung wird die Groß-/Kleinschreibung beachtet. Sie können nur die Parameter verwenden, die für die Filterung nach dem Parameter sortBy verfügbar sind, mit der Ausnahme, dass externalId nicht zulässig ist. Für Werte, die null sind: Sortiert nach aufsteigend: Nullwerte werden nach oben sortiert. Sortiert nach absteigend: Nullwerte werden nach unten sortiert. Datentyp: Zeichenfolge Standard: Keine Sortierung
sortOrder	Muss mit dem Parameter sortBy angegeben werden. Reihenfolge, in der der Parameter sortBy auf die Rückgabeergebnisse angewendet wird. Gültige Werte: Aufsteigend Absteigend Datentyp: Zeichenfolge Standard: aufsteigend
startIndex	Einbasierter Index in der Tabelle, ab der mit dem Abrufen von Datensätzen begonnen werden soll. Wenn Sie diesen Parameter beispielsweise auf 100 und den Parameter count auf 20 festlegen, gibt der Endpunkt die Datensätze 100 bis 119 zurück. Hinweis: Jeder Wert, der auf weniger als eins festgelegt ist, wird als eins interpretiert. Datentyp: Zeichenfolge Standard: 1

Tabelle : 153. Anforderungstextparameter (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/json oder 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 HTTP-Antwortcodesder REST-API.

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 die Abfrageparameter attributes und excludedAttributes nicht in der Anforderung übergeben wurden. Stellen Sie sicher, dass der Parameter count nicht größer als 500 ist. Stellen Sie sicher, dass alle Parameter filter gültig sind.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
itemsProSeite	Anzahl der Datensätze, die in den Rückgabeergebnissen zurückgegeben werden. Datentyp: Zahl
Ressourcen	Liste der zurückgegebenen Standortdatensätze. Datentyp: Objekt "Resources": { "id": "String", "meta": {Object}, "name": "String", "schemas": "String" }
Resources.id	Sys_id des Standortdatensatzes. Datentyp: Zeichenfolge
Resources.meta	Informationen zum Standortdatensatz. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": "String", "resourceType": "String" }
Resources.meta.created	Datum und Uhrzeit der Erstellung des zugeordneten Standortdatensatzes. Datentyp: Zeichenfolge
Resources.meta.lastModified	Datum und Uhrzeit der letzten Änderung des zugeordneten Standortdatensatzes. Datentyp: Zeichenfolge
Resources.meta.location	URI des zugeordneten Standortdatensatzes. Datentyp: Zeichenfolge
Resources.meta.resourceType	SCIM-Ressourcentyp; immer Standort. Datentyp: Zeichenfolge
Resources.name	Standortname. Datentyp: Zeichenfolge
Resources.schemas	Bei der Verarbeitung der Anforderung verwendetes Schema. Datentyp: Zeichenfolge
-Schemata	Schema, das zur Verarbeitung der Listenantwort auf die Anforderung verwendet wird. Beispiel: "urn:ietf:params:scim:api:messages:2.0:ListResponse" Datentyp: Zeichenfolge
startIndex	Einbasierter Index in der Tabelle „Standort“ [cmn_location], an der die Datensätze zurückgegeben wurden. Datentyp: Zeichenfolge
totalResults	Gesamtzahl 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 – GET /scim/Locations/{location_id}

Gibt den angegebenen Standortdatensatz aus der Standorttabelle [cmn_location] innerhalb einer ServiceNow -Instanz unter Verwendung des SCIM-Protokolls (System for Cross-Domain Identity Management) zurück.

URL-Format

Versionierte URL: /api/now/{api_version}/scim/Locations/{location_id}

Standard-URL: /api/now/scim/Locations/{location_id}

Unterstützte Anforderungsparameter

Tabelle : 157. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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
attributes	Kommagetrennte Liste mit Feldern, die in der Antwort zurückgegeben werden sollen. Es werden keine anderen Felder zurückgegeben. Kann nicht mit dem Parameter excludedAttributes verwendet werden. Datentyp: Zeichenfolge Standard: Gibt alle Felder zurück, es sei denn, excludedAttributes ist angegeben.
ausgeschlossene 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 dem Parameter attributes verwendet werden. Datentyp: Zeichenfolge Standard: Keine Felder ausschließen.

Tabelle : 159. Anforderungstextparameter (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/json oder 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 HTTP-Antwortcodesder REST-API.

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 die Abfrageparameter attributes und excludedAttributes nicht in der Anforderung übergeben wurden. Stellen Sie sicher, dass der Parameter count nicht größer als 500 ist. Stellen Sie sicher, dass alle Parameter filter gültig sind.
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.created	Datum und Uhrzeit der Erstellung des zugeordneten Standortdatensatzes. Datentyp: Zeichenfolge
meta.lastModified	Datum und Uhrzeit der letzten Änderung des zugeordneten Standortdatensatzes. Datentyp: Zeichenfolge
meta.location	URI des zugeordneten Standortdatensatzes. Datentyp: Zeichenfolge
meta.resourceType	SCIM-Ressourcentyp; immer Standort. Datentyp: Zeichenfolge
Name	Standortname. Datentyp: Zeichenfolge
-Schemata	Bei der Verarbeitung der Anforderung verwendetes Schema. 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"
}