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

Die System for Cross Domain Identity Management-API (SCIM) 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. von Anwendern und Gruppen, im Web und in domänenübergreifenden Umgebungen, z. B. von Enterprise-to-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 sind entsprechenden Feldern in einer vorhandenen Tabelle ServiceNow zugeordnet. Die folgenden Tabellen definieren diese Zuordnungen. Attribute, die keinen Feldern in vorhandenen Tabellen ServiceNow entsprechen, sind zwei SCIM-spezifischen Tabellen zugeordnet. Weitere Informationen zu diesen Tabellen finden Sie unter SCIM-spezifische Tabellen.

Die Ressource „SCIM-Benutzer“ verfügt über Kernschemata (schema: urn:ietf:params:scim:schemas:core:2.0:User) und Erweiterungsschemas (urn:ietf:params:scim:schemas:extension:servicenow:2.0:User). Die meisten Kern- und Erweiterungsschemaattribute für Benutzer sind der Tabelle „Benutzer“ [sys_user] zugeordnet.

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

SCIM-Attributname	Anwenderfeldname
aktiv	aktiv
adressen.land	country
addresses.default.country	country
addresses.home.country	country
Adressen.Ort	city
adressen.default.locality	city
Adressen.Homepage.Ort	city
adressen.postleitzahl	Postleitzahl
adressen.default.postcode	Postleitzahl
adressen.home.postleitzahl	Postleitzahl
adressen.region	Staat
adressen.standard.region	Staat
Adressen.Homepage.Region	Staat
adressen.straßenadresse	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.Familienname	last_name
Name.Vorname	first_name
name.honorificPrefix	Einführung
name.mittelname	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	Feldname für Sys-Scim-Anwender
externalId	external_id

Das erweiterte Schema für SCIM-Anwender (urn:ietf:params:scim:schemas:extension:servicenow:2.0:User) ist der Tabelle „Anwender“ [sys_user] zugeordnet.

Tabelle : 3. Vom Anwender erweiterte Tabelle „Ressource für Anwender“ [sys_user].

SCIM-Attributname	Anwenderfeldname
unternehmen.name	unternehmen.name
Unternehmenswert	company.sys_id
costCenter.name	„cost_center.name“
Kostenstelle.Wert	„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.wert	manager.sys_id

Das Ressourcenschema der SCIM-Gruppe (urn:ietf:params:scim:schemas:core:2.0:Group) wird der Tabelle „Gruppe“ [sys_user_group] zugeordnet.

Tabelle : 4. Zuordnung der Tabelle „Ressource 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 „externalId“ der SCIM-Gruppe ist der Tabelle „Sys-Scim-Gruppe“ [sys_scim_group] zugeordnet.

Tabelle : 5. Zuordnung von Ressourcen zu Sys-Scim-Gruppe [sys_scim_group]

SCIM-Attributname	Feldname für Sys-Scim-Gruppe
externalId	external_id

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

Tabelle : 6. Zuordnung der Tabelle „Ressource zu Gruppe“ [sys_user_group]

SCIM-Attributname	Gruppenfeldname
Unternehmenswert	company.sys_id
unternehmen.name	unternehmen.name

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

Tabelle : 7. Zuordnung von Unternehmensressourcen zu Unternehmen [core_company].

SCIM-Attributname	Unternehmensfeldname
id	sys_id
meta.created	sys_created_on
meta.lastModified	sys_updated_on
name	name

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

Tabelle : 8. Zuordnung von Kostencenter-Ressourcen zu Kostenstellen [cmn_cost_center].

SCIM-Attributname	Feldname für Kostenstelle
id	sys_id
meta.created	sys_created_on
meta.lastModified	sys_updated_on
name	name

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

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

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

Das Ressourcenschema des SCIM-Standorts (urn:ietf:params:scim:schemas:custom:servicenow:2.0:Location) ist der Tabelle „Standort“ [cmn_location] zugeordnet.

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

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

SCIM-spezifische Tabellen

Die beiden Tabellen „Sys-Scim-Anwender“ [sys_scim_user] und „Sys-Scim-Gruppe“ [sys_scim_group] enthalten die SCIM-Attribute, die keinen vorhandenen ServiceNow -Tabellen zugeordnet sind. Die folgenden Elemente definieren den Inhalt dieser Tabellen.

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 Anwenderdatensatz erstellt hat, um den Anwender im System zu referenzieren. Datentyp: Zeichenfolge Maximale Länge: 255
Sys-ID	Eindeutiger Bezeichner für den Datensatz in 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
Anwender	Verweis auf den Anwender, der diesem Datensatz zugeordnet ist Referenz: Benutzertabelle [sys_user]. Maximale Länge: 32
Anwendertyp	Typ des Anwenderdatensatzes. Dieser Wert wird verwendet, um die Beziehung zwischen Organisation und Anwender zu identifizieren. Dies kann ein beliebiger Wert sein. Typische Werte sind jedoch: 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 im System zu verweisen. Datentyp: Zeichenfolge Maximale Länge: 255
Gruppe	Verweis auf die Gruppe, die diesem Datensatz zugeordnet ist. Referenz: Tabelle „Gruppe“ [sys_user_group] Maximale Länge: 32
Sys-ID	Eindeutiger Bezeichner für den Datensatz in 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 „Anwender“ [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 Tabelle „Gruppe“ [sys_user_group] einer Instanz ServiceNow unter Verwendung des SCIM-Protokolls (System for Cross-Domain Identity Management).

URL-Format

URL mit Versionsnummer: /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. Parameter des Anforderungstexts (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 Content. 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-Fehlerdetailstichwort. Datentyp: Zeichenfolge
Fehler.Schemata	URI der SCIM-Schemas, die zur Verarbeitung der Fehlerantwort verwendet werden. Datentyp: Array von Zeichenfolgen
Fehler.Status	HTTP-Statuscode für die Fehlerantwort. Datentyp: Zeichenfolge

cURL-Anforderung zum Löschen einer Gruppe

In diesem Beispiel wird gezeigt, wie ein Gruppendatensatz aus der Tabelle „Gruppe“ [sys_user_group] gelöscht wird.

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

SCIM: GET /scim/Groups

Gibt einen oder mehrere Gruppendatensätze aus der Tabelle „Gruppe“ [sys_user_group] innerhalb 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 eine Erfolgsmeldung (HTTP-Statuscode 200) zurück, wobei totalResults auf 0 festgelegt ist.

URL-Format

URL mit Versionsnummer: /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, sofern excludedAttributes nicht angegeben ist.
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 für eine schwerwiegende Anforderung. Standard: 10
ausgeschlosseneAttribute	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">. Eine Liste der gültigen Operatoren finden Sie unter RFC7644. 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 geschachtelte Attribute anzugeben. Nur die folgenden SCIM-Gruppenfelder sind für die Verwendung in Filtern verfügbar: displayName externalId: Unterstützt nur EQ- Operator. id meta.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 zwischen Groß- und Kleinschreibung unterschieden. Sie können nur die Parameter verwenden, die zum Filtern für den Parameter sortBy verfügbar sind, außer dass externalId nicht zulässig ist. Für Werte, die NULL sind: aufsteigend sortiert: Null-Werte werden oben sortiert. in absteigender Reihenfolge sortiert: Null-Werte werden 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	Einsbasierter Index in die Tabelle, ab der das Abrufen von Datensätzen beginnen 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. Parameter des Anforderungstexts (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 filter -Parameter gültig sind.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
itemProPage	Anzahl der in den Rückgabeergebnissen zurückgegebenen Datensätze. Datentyp: Zahl
Ressourcen	Liste der Gruppendatensätze. Datentyp: Array von Objekten "Resources": [ { "company": {Object}, "displayName": "String", "externalId": "String", "id": "String", "meta": [Array] } ]
Ressourcen.Unternehmen	Details zum Unternehmen oder zur Organisation der Gruppe. Datentyp: Objekt "company": { "display": "String", "$ref": "String", "value": "String" }
Ressourcen.Unternehmen.Anzeige	Name des Unternehmens. Datentyp: Zeichenfolge
Ressourcen.Unternehmen.$ref	Referenz-URI des Unternehmens. Formatieren:<host> /Unternehmen/<company sys_id> , z. B.: http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 . Datentyp: Zeichenfolge
Ressourcen.Unternehmen.Wert	Sys_id des zugeordneten Unternehmens. Datentyp: Zeichenfolge
Ressourcen.Anzeigename	Visuell lesbarer Name der Gruppe, z. B. „HR-Team“. Datentyp: Zeichenfolge
Ressourcen.externeID	Eindeutiger Bezeichner, der der Gruppe von der bereitstellenden Entität zugewiesen wurde. Datentyp: Zeichenfolge
Resources.id	Sys_id der Gruppe. Datentyp: Zeichenfolge
Resources.meta	Metadaten, die zu der Gruppe gehören. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
Ressourcen.Meta.Erstellt	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
Ressourcen.Mitglieder	Liste der Benutzer und Gruppen, die der Gruppe zugeordnet sind. Datentyp: Array von Objekten "members": [ { "display": "String", "value": "String", "$ref": "String" } ]
Ressourcen.Mitglieder.Anzeige	Name des zugeordneten Gruppenmitglieds. Datentyp: Zeichenfolge
Ressourcen.Mitglieder.Wert	Sys_id des zugeordneten Anwender- 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 Gruppenschemata: urn:ietf:params:scim:schemas:core:2.0:Group: Kernschema, das im Dokument „Internet Engineering Task Force System for Cross-domain Identity Management: Core Schema“ (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 Tabelle „Gruppen“ [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“: Anwenderdefiniertes Erweiterungsschema. Dieses Schema ist Teil des resourceType „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
Schemas	Liste der URIs der SCIM-Listenantwortschemata, die zur Verarbeitung der Anforderung verwendet werden. Datentyp: Array
startIndex	Einbasierter Index in die Tabelle „Gruppe“ [sys_user_group], an der der Endpunkt das Abrufen von Datensätzen gestartet 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) mithilfe des Parameters count und unter Ausschluss der Felder „meta“ und „members“ angefordert 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 Tabelle „Gruppe“ [sys_user_group] innerhalb einer Instanz ServiceNow unter Verwendung des SCIM-Protokolls (System for Cross-Domain Identity Management) zurück.

URL-Format

URL mit Versionsnummer: /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, sofern excludedAttributes nicht angegeben ist.
ausgeschlosseneAttribute	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. Parameter des Anforderungstexts (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 filter -Parameter 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" }
company.display	Name des Unternehmens. Datentyp: Zeichenfolge
Unternehmen.$ref	Referenz-URI des Unternehmens. Formatieren:<host> /Unternehmen/<company sys_id> , z. B.: http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 . Datentyp: Zeichenfolge
Unternehmenswert	Sys_id des zugeordneten Unternehmens. Datentyp: Zeichenfolge
displayName	Visuell lesbarer Name der Gruppe, z. B. „HR-Team“. Datentyp: Zeichenfolge
externalId	Eindeutiger Bezeichner, der der Gruppe von der bereitstellenden Entität zugewiesen wurde. Datentyp: Zeichenfolge
id	Sys_id der Gruppe. Datentyp: Zeichenfolge
meta	Metadaten, die zu der 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 Anwender- oder Gruppendatensatzes. Datentyp: Zeichenfolge
Mitglieder.$ref	URI des zugeordneten Gruppenmitglieds. Datentyp: Zeichenfolge
Schemas	Liste der URIs der SCIM-Gruppenschemata, die zur Verarbeitung der Anforderung verwendet werden. Unterstützte Gruppenschemata: urn:ietf:params:scim:schemas:core:2.0:Group: Kernschema, das im Dokument „Internet Engineering Task Force System for Cross-domain Identity Management: Core Schema“ (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 Tabelle „Gruppen“ [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“: Anwenderdefiniertes Erweiterungsschema. Dieses Schema ist Teil des resourceType „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

In diesem Beispiel wird gezeigt, 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 bestimmter Felder in einem Gruppendatensatz in der Tabelle „Gruppe“ [sys_user_group] einer Instanz ServiceNow unter Verwendung des SCIM-Protokolls (System for Cross-Domain Identity Management).

Weitere Informationen finden Sie im Abschnitt „Modifizieren mit PATCH “ in RFC 7644.

URL-Format

URL mit Versionsnummer: /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, sofern excludedAttributes nicht angegeben ist.
ausgeschlosseneAttribute	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. Parameter des Anforderungstexts (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ügt das angegebene Feld und den angegebenen Wert zum Gruppendatensatz hinzu. entfernen: Entfernt den Wert aus dem angegebenen Feld. Durch den Datentyp „null“ ersetzt. Ersetzen: Ersetzen Sie den Wert des angegebenen Felds. Datentyp: Zeichenfolge
Operations.path	Für Entfernungsvorgänge erforderlich, für andere optional. 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 beispielsweise eine einfache Zeichenfolge aktualisiert wird, z. B. der Titel, wird das Feld value als Zeichenfolge ausgedrückt. "Operations": [ { "op": "add", "path": "displayName", "value": "HR Group" } ] Sie können auch einfache Zeichenfolgenwerte ohne den Parameter path 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
Schemas	Erforderlich. SCIM-Schema-URI des Patch-Vorgangs: „urn:ietf:params:scim:api:messages:2.0:PatchOp“ Datentyp: Zeichenfolge

Header

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

Tabelle : 34. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/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 hängt vom Status der SCIM-UI-Eigenschaft „Gruppen-Patch-API-Antwort ohne Inhalt aktivieren“ab und unterliegt dem Attributparameter, der gemäß RFC übergeben wird: https https://www.rfc-editor.org/rfc/rfc7644#page-35 Standardeigenschaftswert: false Mit der Eigenschaft „ Gruppen-Patch-API aktivieren“ ohne Inhalt können zusätzliche Leistungssteigerungen bei der Antwortausführung erzielt werden, wenn der Client nicht plant, Antwortressourcen zu verbrauchen.
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" }
company.display	Name des Unternehmens. Datentyp: Zeichenfolge
Unternehmen.$ref	Referenz-URI des Unternehmens. Formatieren:<host> /Unternehmen/<company sys_id> , z. B.: http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 . Datentyp: Zeichenfolge
Unternehmenswert	Sys_id des zugeordneten Unternehmens. Datentyp: Zeichenfolge
displayName	Visuell lesbarer Name der Gruppe, z. B. „HR-Team“. Datentyp: Zeichenfolge
externalId	Eindeutiger Bezeichner, der der Gruppe von der bereitstellenden Entität zugewiesen wurde. 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-Fehlerdetailstichwort. Datentyp: Zeichenfolge
Fehler.Schemata	URI der SCIM-Schemas, die zur Verarbeitung der Fehlerantwort verwendet werden. Datentyp: Array von Zeichenfolgen
Fehler.Status	HTTP-Statuscode für die Fehlerantwort. Datentyp: Zeichenfolge
displayName	Visuell lesbarer Name der Gruppe, z. B. „HR-Team“. Datentyp: Zeichenfolge
externalId	Eindeutiger Bezeichner, der der Gruppe von der bereitstellenden Entität zugewiesen wurde. 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 Anwender- oder Gruppendatensatzes. Datentyp: Zeichenfolge
Mitglieder.$ref	URI des zugeordneten Gruppenmitglieds. Datentyp: Zeichenfolge
meta	Metadaten, die zu der 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
Schemas	Liste der URIs der SCIM-Gruppenschemata, die zur Verarbeitung der Anforderung verwendet werden. Unterstützte Gruppenschemata: urn:ietf:params:scim:schemas:core:2.0:Group: Kernschema, das im Dokument „Internet Engineering Task Force System for Cross-domain Identity Management: Core Schema“ (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 Tabelle „Gruppen“ [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“: Anwenderdefiniertes Erweiterungsschema. Dieses Schema ist Teil des resourceType „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

In diesem Beispiel wird gezeigt, wie Sie einem Gruppendatensatz eine externe ID hinzufügen und die aktuelle Liste der zugehörigen 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 Tabelle „Gruppe“ [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 Korrelation dieser Gruppe mit einem externen System verwendet wird, und der Gruppe Mitglieder (Anwender/Gruppen) hinzufügen.

Hinweis:

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

URL-Format

URL mit Versionsnummer: /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, sofern excludedAttributes nicht angegeben ist.
ausgeschlosseneAttribute	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. Parameter des Anforderungstexts (JSON)

Name	Beschreibung
Unternehmen	Details zum Unternehmen oder zur Organisation der Gruppe. Datentyp: Objekt "company": { "display": "String", "$ref": "String", "value": "String" }
company.display	Name des Unternehmens. Datentyp: Zeichenfolge
Unternehmen.$ref	Referenz-URI des Unternehmens. Formatieren:<host> /Unternehmen/<company sys_id> , z. B.: http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 . Datentyp: Zeichenfolge
Unternehmenswert	Sys_id des zugeordneten Unternehmens. Datentyp: Zeichenfolge
displayName	Erforderlich. Visuell lesbarer Name der Gruppe, z. B. „HR-Team“. Datentyp: Zeichenfolge
externalId	Eindeutiger Bezeichner, der der Gruppe von der bereitstellenden Entität zugewiesen wurde. Datentyp: Zeichenfolge
Mitglieder	Liste der Benutzer oder anderer 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 Anwender- oder Gruppendatensatzes. Datentyp: Zeichenfolge
Schemas	Erforderlich. Liste der URIs der SCIM-Gruppenschemata, die zur Verarbeitung der Anforderung verwendet werden. Unterstützte Gruppenschemata: urn:ietf:params:scim:schemas:core:2.0:Group: Kernschema, das im Dokument „Internet Engineering Task Force System for Cross-domain Identity Management: Core Schema“ (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 Tabelle „Gruppen“ [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“: Anwenderdefiniertes Erweiterungsschema. Dieses Schema ist Teil des resourceType „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" }
company.display	Name des Unternehmens. Datentyp: Zeichenfolge
Unternehmen.$ref	Referenz-URI des Unternehmens. Formatieren:<host> /Unternehmen/<company sys_id> , z. B.: http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 . Datentyp: Zeichenfolge
Unternehmenswert	Sys_id des zugeordneten Unternehmens. Datentyp: Zeichenfolge
displayName	Visuell lesbarer Name der Gruppe, z. B. „HR-Team“. Datentyp: Zeichenfolge
externalId	Eindeutiger Bezeichner, der der Gruppe von der bereitstellenden Entität zugewiesen wurde. Datentyp: Zeichenfolge
id	Sys_id der Gruppe. Datentyp: Zeichenfolge
meta	Metadaten, die zu der 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 Anwender- oder Gruppendatensatzes. Datentyp: Zeichenfolge
Mitglieder.$ref	URI des zugeordneten Gruppenmitglieds. Datentyp: Zeichenfolge
Schemas	Liste der URIs der SCIM-Gruppenschemata, die zur Verarbeitung der Anforderung verwendet werden. Unterstützte Gruppenschemata: urn:ietf:params:scim:schemas:core:2.0:Group: Kernschema, das im Dokument „Internet Engineering Task Force System for Cross-domain Identity Management: Core Schema“ (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 Tabelle „Gruppen“ [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“: Anwenderdefiniertes Erweiterungsschema. Dieses Schema ist Teil des resourceType „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 POST einer neuen Gruppe und Hinzufügen eines Mitglieds

In diesem Beispiel wird die Gruppe 51 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 Tabelle „Gruppe“ [sys_user_group] einer Instanz ServiceNow unter Verwendung des SCIM-Protokolls (System for Cross-Domain Identity Management).

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

URL-Format

URL mit Versionsnummer: /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, sofern excludedAttributes nicht angegeben ist.
ausgeschlosseneAttribute	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. Parameter des Anforderungstexts (JSON)

Name	Beschreibung
Unternehmen	Details zum Unternehmen oder zur Organisation der Gruppe. Datentyp: Objekt "company": { "display": "String", "$ref": "String", "value": "String" }
company.display	Name des Unternehmens. Datentyp: Zeichenfolge
Unternehmen.$ref	Referenz-URI des Unternehmens. Formatieren:<host> /Unternehmen/<company sys_id> , z. B.: http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 . Datentyp: Zeichenfolge
Unternehmenswert	Sys_id des zugeordneten Unternehmens. Datentyp: Zeichenfolge
displayName	Visuell lesbarer Name der Gruppe, z. B. „HR-Team“. Datentyp: Zeichenfolge
externalId	Eindeutiger Bezeichner, der der Gruppe von der bereitstellenden Entität zugewiesen wurde. Datentyp: Zeichenfolge
Mitglieder	Liste der Anwender, 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 Anwender- oder Gruppendatensatzes. Datentyp: Zeichenfolge
Schemas	Erforderlich. Liste der URIs der SCIM-Gruppenschemata, die zur Verarbeitung der Anforderung verwendet werden. Unterstützte Gruppenschemata: urn:ietf:params:scim:schemas:core:2.0:Group: Kernschema, das im Dokument „Internet Engineering Task Force System for Cross-domain Identity Management: Core Schema“ (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 Tabelle „Gruppen“ [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“: Anwenderdefiniertes Erweiterungsschema. Dieses Schema ist Teil des resourceType „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" }
company.display	Name des Unternehmens. Datentyp: Zeichenfolge
Unternehmen.$ref	Referenz-URI des Unternehmens. Formatieren:<host> /Unternehmen/<company sys_id> , z. B.: http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 . Datentyp: Zeichenfolge
Unternehmenswert	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-Fehlerdetailstichwort. Datentyp: Zeichenfolge
Fehler.Schemata	URI der SCIM-Schemas, die zur Verarbeitung der Fehlerantwort verwendet werden. Datentyp: Array von Zeichenfolgen
Fehler.Status	HTTP-Statuscode für die Fehlerantwort. Datentyp: Zeichenfolge
externalId	Eindeutiger Bezeichner, der der Gruppe von der bereitstellenden Entität zugewiesen wurde. 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 Anwender- oder Gruppendatensatzes. Datentyp: Zeichenfolge
Mitglieder.$ref	URI des zugeordneten Gruppenmitglieds. Datentyp: Zeichenfolge
meta	Metadaten, die zu der 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
Schemas	Liste der URIs der SCIM-Gruppenschemata, die zur Verarbeitung der Anforderung verwendet werden. Unterstützte Gruppenschemata: urn:ietf:params:scim:schemas:core:2.0:Group: Kernschema, das im Dokument „Internet Engineering Task Force System for Cross-domain Identity Management: Core Schema“ (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 Tabelle „Gruppen“ [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“: Anwenderdefiniertes Erweiterungsschema. Dieses Schema ist Teil des resourceType „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 zur Aktualisierung von Gruppenmitgliedern mithilfe von PUT

Im folgenden Beispiel wird das der Gruppe zugeordnete Mitglied von „Abel Tutor“ in „Abraham Lincoln“ geändert und der Name der Gruppe in „HR Team“ geändert.

curl "https://instance-servicenow.com/api/now/scim/Groups/e0140d671bbe3010593876a61a4bcb11" \
--request PUT \
--header "Accept:application/scim+json" \
--header "Content-Type:application/scim+json" \
--data "{
  \"schemas\": ["urn:ietf:params:scim:schemas:core:2.0:Group",
    “urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group”, 
    “urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group”],
  \"displayName\": \"HR Team\",
  \"externalId\": \"8ae5dc9e-c7ad-4d3d-a152-35a6b6222b83\",
  \"members\": [
    {
      \"value\": \"a8f98bb0eb32010045e1a5115206fe3a\",
      \"$ref\": \"Users\"
    }
  ]
}" 

Antwort:

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

SCIM - DELETE /scim/Users/{user_id}

Löscht den angegebenen Anwenderdatensatz aus der Anwendertabelle [sys_user] einer Instanz ServiceNow unter Verwendung des SCIM-Protokolls (System for Cross-Domain Identity Management).

URL-Format

URL mit Versionsnummer: /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 Anwenderdatensatzes.

Tabelle : 50. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 51. Parameter des Anforderungstexts (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 Content. 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-Fehlerdetailstichwort. Datentyp: Zeichenfolge
Fehler.Schemata	URI der SCIM-Schemas, die zur Verarbeitung der Fehlerantwort verwendet werden. Datentyp: Array von Zeichenfolgen
Fehler.Status	HTTP-Statuscode für die Fehlerantwort. Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel wird gezeigt, wie ein Benutzerdatensatz aus der Tabelle „Benutzer“ [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 Anwenderdatensätze aus der Anwendertabelle [sys_user] 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 eine Erfolgsmeldung (HTTP-Statuscode 200) zurück, wobei totalResults auf 0 festgelegt ist.

URL-Format

URL mit Versionsnummer: /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, sofern excludedAttributes nicht angegeben ist.
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 für eine schwerwiegende Anforderung. Standard: 10
ausgeschlosseneAttribute	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">. Eine Liste der gültigen Operatoren finden Sie unter RFC7644. Hinweis: Der NOT- Operator wird nicht unterstützt. Um beispielsweise nach allen Anwendern 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 Anwendern zu filtern, deren Name mit „Jo“ beginnt und deren Nachname „smi“ enthält, geben Sie userName SW „john“ AND name.familyName CO „smi“ ein. Verwenden Sie Dot-Walking, um geschachtelte Attribute anzugeben. Nur die folgenden SCIM-Anwenderfelder sind für die Verwendung in Filtern verfügbar, und einige unterstützen, wie erwähnt, nur ein festes Format: aktiv Adressen: Nur festes Format, z. B.: [type eq „home“ andstreetAddress eq „xxxx“] [type eq „home“ and locality eq „xxxx“] [type eq „home“ and Region eq „xxxx“] [type eq „home“ and postCode eq „xxxx“] [type eq „home“ andcountry 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.Familienname Name.Vorname name.mittelname bevorzugteSprache phoneNumbers: Nur festes Format, z. B.: [type eq „work“ und Wert eq „xxxx“] [type eq „mobile“ und Wert eq „xxxx“] [type eq „home“ und Wert 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 zwischen Groß- und Kleinschreibung unterschieden. Sie können nur die Parameter verwenden, die zum Filtern für den Parameter sortBy verfügbar sind, mit Ausnahme von externalId, was nicht zulässig ist. Außerdem werden nur die folgenden Dot-Walking-Parameter unterstützt: addressess Nur die folgenden Werte sind zulässig: addresses.streetAddress Zuordnung zu privater Adresse addresses.home.streetAddress addresses.locality Zuordnung zum Heimatort. addresses.home.locality addresses.region Zuordnungen zur Heimatregion. addresses.home.region addresses.postalCode Zuordnungen zur Postleitzahl (privat). addresses.home.postalCode addresses.country Zuordnung zum Heimatland. addresses.home.country emails Nur die folgenden Werte sind zulässig: emails.value Zuordnung zum E-Mail-Typ Arbeit. emails.work.value phoneNumbers Nur die folgenden Werte sind zulässig: phoneNumbers.value Zuordnung zum Telefonnummerntyp Arbeit. phoneNumbers.home.value phoneNumbers.mobile.value phoneNumbers.work.value Für Werte, die NULL sind: aufsteigend sortiert: Null-Werte werden oben sortiert. in absteigender Reihenfolge sortiert: Null-Werte werden 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 die Anwendertabelle [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. Nicht gü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 filter -Parameter gültig sind.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
itemProPage	Anzahl der in den Rückgabeergebnissen zurückgegebenen Datensätze. 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 Anwender innerhalb der Instanz ServiceNow aktiv ist. Mögliche Werte: wahr: Anwender ist aktiv. „falsch“: Anwender ist inaktiv. Datentyp: Boolesch
Resources.adresses	Details zur aktuellen Postanschrift des Anwenders. Datentyp: Objekt "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" }
Resources.addresses.country	Ländername. Datentyp: Zeichenfolge
Ressourcen.Adressen.Ortszeit	Name der Stadt oder des Ortes. Datentyp: Zeichenfolge
Ressourcen.Adressen.Postleitzahl	Postleitzahl. Datentyp: Zeichenfolge
Ressourcen.Adressen.Region	Bundesland oder Region. Datentyp: Zeichenfolge
Ressourcen.Adressen.StreetAddress	Vollständige Adresse mit Straße und Hausnummer. Dies kann die Hausnummer, der Straßenname, das Postfach und mehrzeilige erweiterte Straßeninformationen enthalten. Datentyp: Zeichenfolge
Ressourcen.Adressen.Typ	Typ der Adresse Unterstützt derzeit nur Homepagevon. Datentyp: Zeichenfolge
Ressourcen.Anzeigename	Anzeigename des Anwenders. Dieser Wert wird durch Verketten der Felder name automatisch generiert. Datentyp: Zeichenfolge
Resources.emails	Liste der E-Mail-Accounts, die dem Anwender zugeordnet sind. Datentyp: Array von Objekten "emails:" [ { "type": "String", "value": "String" } ]
Ressourcen.E-Mails.Typ	E-Mail-Typ des Anwenders. Unterstützt derzeit nur den Typ „Arbeit“. Datentyp: Zeichenfolge
Ressourcen.E-Mails.Wert	E-Mail-Adresse des Anwenders. Dies ist ein eindeutiger Schlüssel für den zugeordneten Anwender. Datentyp: Zeichenfolge
Ressourcen.externeID	Eindeutiger Bezeichner, der dem Anwender von der bereitstellenden Entität zugewiesen wurde. Datentyp: Zeichenfolge
Resources.groups	Liste der Gruppen, denen der Anwender angehört, entweder über direkte Mitgliedschaft, über geschachtelte Gruppen oder dynamisch berechnet. Datentyp: Array von Objekten "groups": [ { "display": "String", "type": "String", "value": "String", "$ref": "String" } ]
Ressourcen.Gruppen.Anzeige	Name der zugeordneten Gruppe. Datentyp: Zeichenfolge
Ressourcen.Gruppen.Typ	Typ der Gruppenzuordnung, z. B. direkt oder indirekt. Datentyp: Zeichenfolge
Ressourcen.Gruppen.Wert	Sys_id eines zugeordneten Gruppendatensatzes. Datentyp: Zeichenfolge
Resources.groups.ref	URI der zugeordneten Gruppe. Datentyp: Zeichenfolge
Resources.id	Sys_id des zugeordneten Anwenderdatensatzes. Datentyp: Zeichenfolge
Resources.meta	Metadaten, die sich auf den Anwender beziehen. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
Ressourcen.Meta.Erstellt	Datum und Uhrzeit der Erstellung des Anwenderdatensatzes. Datentyp: Zeichenfolge
Resources.meta.lastModified	Datum und Uhrzeit der letzten Änderung des Anwenderdatensatzes. Datentyp: Zeichenfolge
Resources.meta.location	URI des abgerufenen Anwenders. Datentyp: Zeichenfolge
Resources.meta.resourceType	Ressourcentyp der SCIM-Anwender. Datentyp: Zeichenfolge
Resources.name	Informationen zum Namen des Benutzers. Datentyp: Objekt "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" }
Ressourcen.Name.Familienname	Familien- oder Nachname des Anwenders. Datentyp: Zeichenfolge
Ressourcen.Name.Vorname	Vor- oder Vorname des Anwenders. Datentyp: Zeichenfolge
Resources.name.honorificPrefix	Ehrungsname oder -titel des Anwenders, z. B. Dr., Bistum oder Vendor. Datentyp: Zeichenfolge
Ressourcen.Name.Mitte	Zweiter Vorname des Anwenders. Datentyp: Zeichenfolge
Ressourcen.Telefonnummern	Liste der Telefonnummern, die dem Benutzer zugeordnet sind. Datentyp: Array von Objekten "phoneNumbers": [ { "type": "String", "value": "String" } ]
Ressourcen.Telefonnummern.Typ	Typ der Telefonnummer. Mögliche Werte: Homepage Mobile Arbeit Datentyp: Zeichenfolge
Ressourcen.Telefonnummern.Wert	Telefonnummer des Benutzers. Datentyp: Zeichenfolge
Ressourcen.bevorzugteSprache	Bevorzugte gesprochene und geschriebene Sprache des Anwenders. Datentyp: Zeichenfolge
Resources.schemas	Liste der URIs der SCIM-Anwenderschemata, die zur Verarbeitung der Anforderung verwendet werden. Datentyp: Array von Zeichenfolgen
Ressourcen.Zeitzone	Zeitzone des Benutzers. Datentyp: Zeichenfolge
Ressourcen.Titel	Titel des Anwenders, z. B. CEO oder President. Datentyp: Zeichenfolge
Ressourcen.Anwendername	Eindeutiger Anwendername für den zugeordneten Anwender. Datentyp: Zeichenfolge
Ressourcen.Anwendertyp	Benutzertyp Dieser Wert wird verwendet, um die Beziehung zwischen Organisation und Anwender zu identifizieren. Dies kann ein beliebiger Wert sein. Typische Werte sind jedoch: Vertragsunternehmen Mitarbeiter Praktikanten Temp Extern Unbekannt Datentyp: Zeichenfolge
Schemas	Liste der URIs der SCIM-ListResponse-Schemata, die zur Verarbeitung der Anforderung verwendet werden. Datentyp: Array von Zeichenfolgen
startIndex	Einbasierter Index in die Anwendertabelle [sys_user], in 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" }
company.display	Name des Unternehmens. Datentyp: Zeichenfolge
Unternehmenswert	Sys_id des Unternehmensdatensatzes. Datentyp: Zeichenfolge
Unternehmen.$ref	Referenz-URI für das Unternehmen. Datentyp: Zeichenfolge
Kostenstelle	Details zur Kostenstelle des Benutzers. Datentyp: Objekt "costCenter": { "display": "String", "value": "String", "$ref": "String" }
Kostenstelle.Anzeige	Name der Kostenstelle. Datentyp: Zeichenfolge
Kostenstelle.Wert	Sys_id des Kostenstellen-Datensatzes. Datentyp: Zeichenfolge
Kostenstelle.$ref	Referenz-URI für die Kostenstelle. Datentyp: Zeichenfolge
department	Details zur Abteilung des Anwenders. Datentyp: Objekt "department": { "display": "String", "value": "String", "$ref": "String" }
abteilung.anzeigen	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 Anwenders, z. B. männlich oder weib. Datentyp: Zeichenfolge
location	Details zum zugeordneten Standort des Anwenders. Datentyp: Objekt "location": { "display": "String", "value": "String", "$ref": "String" }
location.display	Name des Standorts. Datentyp: Zeichenfolge
location.value	Sys_id des Standortdatensatzes. Datentyp: Zeichenfolge
location.$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.wert	Sys_id des Manager-Datensatzes. Datentyp: Zeichenfolge
manager.$ref	Referenz-URI für den Manager. Datentyp: Zeichenfolge

cURL-Anforderung mithilfe von Attributen

Das folgende Beispiel zeigt, wie Sie ab dem sechsten Datensatz zwei Benutzer abrufen und nur den Anzeigenamen zurückgeben.

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

Antwort:

{"schemas":
  ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
  "totalResults":619,
  "Resources":
    [
      {
        "schemas":
          [
            "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User",
            "urn:ietf:params:scim:schemas:core:2.0:User"
          ],
        "id":"02826bf03710200044e0bfc8bcbe5d6d",
        "displayName":"Sean Bonnet"
      },
      {
        "schemas":
          [
            "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User",
            "urn:ietf:params:scim:schemas:core:2.0:User"
           ],
         "id":"02826bf03710200044e0bfc8bcbe5d76",
         "displayName":"Jacinto Gawron"
      }
    ],
  "startIndex":6,
  "itemsPerPage":2
}

cURL-Anforderung mithilfe eines Filters

Das folgende Beispiel zeigt, wie der Parameter filter verwendet wird, um die ersten beiden Anwenderdatensätze zurückzugeben, deren angegebener Name mit „a“ beginnt.

curl "https://instance-servicenow.com/api/now/scim/Users?filter=name.givenName%20SW%20%22a%22&count=2" \
--request GET \
--header "Accept:application/scim+json" \

Antwort:

{"schemas":
  ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
  "totalResults":42,
  "Resources":
    [
      {
        "schemas":
          [
            "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User",
            "urn:ietf:params:scim:schemas:core:2.0:User"
          ],
        "id":"06826bf03710200044e0bfc8bcbe5d8a",
        "meta":
          {
            "resourceType":"User",
            "created":"2012-02-18T03:04:50Z",
            "lastModified":"2021-10-01T14:23:32Z",
            "location":"https://instance-servicenow.com/api/now/scim/Users/06826bf03710200044e0bfc8bcbe5d8a"
          },
          "userName":"allyson.gillispie",
          "name":
            {
              "familyName":"Gillispie",
              "givenName":"Allyson"
            },
          "displayName":"Allyson Gillispie",
          "active":true,
          "emails":
            [
              {
                "value":"[e-mail]",
                "type":"work"
              }
            ],
          "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User":
            {
              "gender":"Female",
              "costCenter":
                {
                  "value":"d9d07bddc0a80a647cf932056ed24652",
                  "name":"Engineering"
                },
              "company":
                {
                  "value":"31bea3d53790200044e0bfc8bcbe5dec",
                  "name":"ACME North America"
                },
              "department":
                {
                  "value":"221f3db5c6112284009f4becd3039cc9",
                  "name":"Development"
                },
              "location":
                {
                  "value":"f9084ba00a0a0b910060ba2ce83f882b",
                  "name":"946 Donax Avenue, Imperial Beach,CA"
                }
            }
         },
      {
        "schemas":
          [
            "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User",
            "urn:ietf:params:scim:schemas:core:2.0:User"
          ],
        "id":"0a826bf03710200044e0bfc8bcbe5d7a"
        "meta":
          {
            "resourceType":"User",
            "created":"2012-02-18T03:04:50Z",
            "lastModified":"2021-10-01T14:23:32Z",
            "location":"https://instance-servicenow.com/api/now/scim/Users/0a826bf03710200044e0bfc8bcbe5d7a"
          },
        "userName":"adela.cervantsz",
        "name":
          {
            "familyName":"Cervantsz",
            "givenName":"Adela"
          },
        "displayName":"Adela Cervantsz",
        "active":true,
        "emails":
          [
            {
              "value":"[e-mail]",
              "type":"work"
            }
          ],
        "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User":
          {
            "gender":"Female",
            "costCenter":
              {
                "value":"91e8bbf43710200044e0bfc8bcbe5daa",
                "name":"Customer Support"
              },
            "company":
              {
                "value":"31bea3d53790200044e0bfc8bcbe5dec",
                "name":"ACME North America"
              },
            "department":
              {
                "value":"5d7f17f03710200044e0bfc8bcbe5d43",
                "name":"Customer Support"
              },
            "location":
              {
                "value":"25ab93750a0a0bb30067bd2ef3d4a5c9",
                "name":"8306 Mills Drive, Miami,FL"
              }
          }
    }
  ],
  "startIndex":1,
  "itemsPerPage":2
}

SCIM – GET /scim/Users/{user_id}

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

URL-Format

URL mit Versionsnummer: /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 Anwenderdatensatzes. 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, sofern excludedAttributes nicht angegeben ist.
ausgeschlosseneAttribute	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. Parameter des Anforderungstexts (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 filter -Parameter 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 Anwender innerhalb der Instanz ServiceNow aktiv ist. Mögliche Werte: wahr: Anwender ist aktiv. „falsch“: Anwender ist inaktiv. Datentyp: Boolesch
addresses	Details zur aktuellen Postanschrift des Anwenders. Datentyp: Objekt "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" }
adressen.land	Ländername. Datentyp: Zeichenfolge
Adressen.Ort	Name der Stadt oder des Ortes. Datentyp: Zeichenfolge
adressen.postleitzahl	Postleitzahl. Datentyp: Zeichenfolge
adressen.region	Bundesland oder Region. Datentyp: Zeichenfolge
adressen.straßenadresse	Vollständige Adresse mit Straße und Hausnummer. Dies kann die Hausnummer, der Straßenname, das Postfach und mehrzeilige erweiterte Straßeninformationen enthalten. Datentyp: Zeichenfolge
adressen.type	Typ der Adresse Unterstützt derzeit nur Homepagevon. Datentyp: Zeichenfolge
displayName	Anzeigename des Anwenders. Dieser Wert wird durch Verketten der Felder name automatisch generiert. Datentyp: Zeichenfolge
E-Mails	Liste der E-Mail-Accounts, die dem Anwender zugeordnet sind. Datentyp: Array von Objekten "emails:" [ { "type": "String", "value": "String" } ]
emails.type	E-Mail-Typ des Anwenders. Unterstützt derzeit nur den Typ „Arbeit“. Datentyp: Zeichenfolge
emails.value	E-Mail-Adresse des Anwenders. Dies ist ein eindeutiger Schlüssel für den zugeordneten Anwender. Datentyp: Zeichenfolge
externalId	Eindeutiger Bezeichner, der dem Anwender von der bereitstellenden Entität zugewiesen wurde. Datentyp: Zeichenfolge
groups	Liste der Gruppen, denen der Anwender angehört, entweder über direkte Mitgliedschaft, über geschachtelte Gruppen oder dynamisch berechnet. Datentyp: Array von Objekten "groups": [ { "display": "String", "type": "String", "value": "String", "$ref": "String" } ]
gruppen.anzeigen	Name der zugeordneten Gruppe. Datentyp: Zeichenfolge
Gruppen.Typ	Typ der Gruppenzuordnung, z. B. direkt oder indirekt. Datentyp: Zeichenfolge
gruppen.wert	Sys_id eines zugeordneten Gruppendatensatzes. Datentyp: Zeichenfolge
Gruppen.$ref	URI der zugeordneten Gruppe. Datentyp: Zeichenfolge
id	Sys_id des zugeordneten Anwenderdatensatzes. Datentyp: Zeichenfolge
meta	Metadaten, die sich auf den Anwender beziehen. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
meta.created	Datum und Uhrzeit der Erstellung des Anwenderdatensatzes. Datentyp: Zeichenfolge
meta.lastModified	Datum und Uhrzeit der letzten Änderung des Anwenderdatensatzes. Datentyp: Zeichenfolge
meta.location	URI des abgerufenen Anwenders. Datentyp: Zeichenfolge
meta.resourceType	Ressourcentyp der SCIM-Anwender. Datentyp: Zeichenfolge
name	Informationen zum Namen des Benutzers. Datentyp: Objekt "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" }
Name.Familienname	Familien- oder Nachname des Anwenders. Datentyp: Zeichenfolge
Name.Vorname	Vor- oder Vorname des Anwenders. Datentyp: Zeichenfolge
name.honorificPrefix	Ehrungsname oder -titel des Anwenders, z. B. Dr., Bistum oder Vendor. Datentyp: Zeichenfolge
Name.Mitte	Zweiter Vorname des Anwenders. 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 Anwenders. Datentyp: Zeichenfolge
Schemas	Liste der URIs der SCIM-Anwenderschemata, die zur Verarbeitung der Anforderung verwendet werden. Datentyp: Array von Zeichenfolgen
Feld	Zeitzone des Benutzers. Datentyp: Zeichenfolge
Titel	Titel des Anwenders, z. B. CEO oder President. Datentyp: Zeichenfolge
userName	Eindeutiger Anwendername für den zugeordneten Anwender. Datentyp: Zeichenfolge
userType	Benutzertyp Dieser Wert wird verwendet, um die Beziehung zwischen Organisation und Anwender zu identifizieren. Dies kann ein beliebiger Wert sein. Typische Werte sind jedoch: 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" }
company.display	Name des Unternehmens. Datentyp: Zeichenfolge
Unternehmenswert	Sys_id des Unternehmensdatensatzes. Datentyp: Zeichenfolge
Unternehmen.$ref	Referenz-URI für das Unternehmen. Datentyp: Zeichenfolge
Kostenstelle	Details zur Kostenstelle des Benutzers. Datentyp: Objekt "costCenter": { "display": "String", "value": "String", "$ref": "String" }
Kostenstelle.Anzeige	Name der Kostenstelle. Datentyp: Zeichenfolge
Kostenstelle.Wert	Sys_id des Kostenstellen-Datensatzes. Datentyp: Zeichenfolge
Kostenstelle.$ref	Referenz-URI für die Kostenstelle. Datentyp: Zeichenfolge
department	Details zur Abteilung des Anwenders. Datentyp: Objekt "department": { "display": "String", "value": "String", "$ref": "String" }
abteilung.anzeigen	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 Anwenders, z. B. männlich oder weib. Datentyp: Zeichenfolge
location	Details zum zugeordneten Standort des Anwenders. Datentyp: Objekt "location": { "display": "String", "value": "String", "$ref": "String" }
location.display	Name des Standorts. Datentyp: Zeichenfolge
location.value	Sys_id des Standortdatensatzes. Datentyp: Zeichenfolge
location.$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.wert	Sys_id des Manager-Datensatzes. Datentyp: Zeichenfolge
manager.$ref	Referenz-URI für den Manager. Datentyp: Zeichenfolge

cURL-Anforderung mit Anwender-sys_id

Das folgende Beispiel zeigt, wie Sie einen bestimmten Benutzerdatensatz durch Übergabe seiner sys_id abrufen.

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

Antwort:

{"schemas":
  [
    "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User",
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
    "id":"62826bf03710200044e0bfc8bcbe5df1",
    "meta":
      {
        "resourceType":"User",
        "created":"2012-02-18T03:04:52Z",
        "lastModified":"2021-10-01T14:23:34Z",
        "location":"https://instance-servicenow.com/api/now/scim/Users/62826bf03710200044e0bfc8bcbe5df1"
      },
    "userName":"abel.tuter",
    "name":
      {
        "familyName":"Tuter",
        "givenName":"Abel"
      },
    "displayName":"Abel Tuter",
    "active":true,
    "emails":[
      {
        "value":"[e-mail]",
        "type":"work"
      }
    ],
    "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User":
      {
        "gender":"Male",
        "costCenter":
          {
            "value":"d9d07bddc0a80a647cf932056ed24652",
            "name":"Engineering"
          },
        "company":
          {
            "value":"227cdfb03710200044e0bfc8bcbe5d6b",
            "name":"ACME South America"
          },
        "department":
          {
            "value":"9a7ed3f03710200044e0bfc8bcbe5db7",
            "name":"Product Management"
           },
        "location":
          {
            "value":"25b3d04b0a0a0bb300176b546c22db27",
            "name":"SHS quadra 5, Bloco E., Brasilia"}
          }
      }

SCIM – PATCH /scim/Users/{user_id}

Ermöglicht Ihnen das Hinzufügen, Ersetzen und Entfernen bestimmter Felder in einem Benutzerdatensatz in der Benutzertabelle [sys_user] einer Instanz ServiceNow unter Verwendung des SCIM-Protokolls (System for Cross-Domain Identity Management).

URL-Format

URL mit Versionsnummer: /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 Anwenderdatensatzes.

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, sofern excludedAttributes nicht angegeben ist.
ausgeschlosseneAttribute	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. Parameter des Anforderungstexts (JSON)

Name	Beschreibung
Vorgänge	Erforderlich. Liste der Vorgangsobjekte, mit denen der angegebene Anwenderdatensatz gepatcht werden soll. Datentyp: Array "Operations": [ { "op": "String", "path": "String", "value": Any } ]
Operations.op	Erforderlich. Auszuführender Vorgang. Gültige Werte: Hinzufügen: Fügen Sie dem Benutzerdatensatz das angegebene Feld und den angegebenen Wert hinzu. entfernen: Entfernt 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 auf ein bestimmtes Element mit einem Filter verwiesen werden, 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: Berücksichtigt 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 beispielsweise eine einfache Zeichenfolge aktualisiert wird, z. B. der Titel, 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 mit Objekten handelt, die zusätzliche Felder zum Hinzufügen zum Benutzerdatensatz und die zugehörigen Werte definieren, 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" } ] } ] Wenn Attributknoten angegeben werden, 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
Schemas	Erforderlich. SCIM-Schema-URI des Patch -Vorgangs urn:ietf:params:scim:api:messages:2.0:PatchOp. Datentyp: Zeichenfolge

Header

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

Tabelle : 70. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/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 Anwender innerhalb der Instanz ServiceNow aktiv ist. Mögliche Werte: wahr: Anwender ist aktiv. „falsch“: Anwender ist inaktiv. Datentyp: Boolesch
addresses	Details zur aktuellen Postanschrift des Anwenders. Datentyp: Objekt "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" }
adressen.land	Ländername. Datentyp: Zeichenfolge
Adressen.Ort	Name der Stadt oder des Ortes. Datentyp: Zeichenfolge
adressen.postleitzahl	Postleitzahl. Datentyp: Zeichenfolge
adressen.region	Bundesland oder Region. Datentyp: Zeichenfolge
adressen.straßenadresse	Vollständige Adresse mit Straße und Hausnummer. Dies kann die Hausnummer, der Straßenname, das Postfach und mehrzeilige erweiterte Straßeninformationen enthalten. Datentyp: Zeichenfolge
adressen.type	Typ der Adresse Unterstützt derzeit nur Homepagevon. Datentyp: Zeichenfolge
displayName	Anzeigename des Anwenders. Dieser Wert wird durch Verketten der Felder name automatisch generiert. Datentyp: Zeichenfolge
E-Mails	Liste der E-Mail-Accounts, die dem Anwender zugeordnet sind. Datentyp: Array von Objekten "emails:" [ { "type": "String", "value": "String" } ]
emails.type	E-Mail-Typ des Anwenders. Unterstützt derzeit nur den Typ „Arbeit“. Datentyp: Zeichenfolge
emails.value	E-Mail-Adresse des Anwenders. Dies ist ein eindeutiger Schlüssel für den zugeordneten Anwender. Datentyp: Zeichenfolge
Fehler	Antwort, die alle Fehler beschreibt, die während der Verarbeitung der Anforderung aufgetreten sind. Datentyp: Objekt "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" }
Fehler.detail	Detaillierte Fehlermeldung, warum die Anforderung fehlgeschlagen ist. Datentyp: Zeichenfolge
Fehler.scimType	SCIM-Fehlerdetailstichwort. Datentyp: Zeichenfolge
Fehler.Schemata	URI der SCIM-Schemas, die zur Verarbeitung der Fehlerantwort verwendet werden. Datentyp: Array von Zeichenfolgen
Fehler.Status	HTTP-Statuscode für die Fehlerantwort. Datentyp: Zeichenfolge
externalId	Eindeutiger Bezeichner, der dem Anwender von der bereitstellenden Entität zugewiesen wurde. Datentyp: Zeichenfolge
groups	Liste der Gruppen, denen der Anwender angehört, entweder über direkte Mitgliedschaft, über geschachtelte Gruppen oder dynamisch berechnet. Datentyp: Array von Objekten "groups": [ { "display": "String", "type": "String", "value": "String", "$ref": "String" } ]
gruppen.anzeigen	Name der zugeordneten Gruppe. Datentyp: Zeichenfolge
Gruppen.Typ	Typ der Gruppenzuordnung, z. B. direkt oder indirekt. Datentyp: Zeichenfolge
gruppen.wert	Sys_id eines zugeordneten Gruppendatensatzes. Datentyp: Zeichenfolge
Gruppen.$ref	URI der zugeordneten Gruppe. Datentyp: Zeichenfolge
id	Sys_id des zugeordneten Anwenderdatensatzes. Datentyp: Zeichenfolge
meta	Metadaten, die sich auf den Anwender beziehen. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
meta.created	Datum und Uhrzeit der Erstellung des Anwenderdatensatzes. Datentyp: Zeichenfolge
meta.lastModified	Datum und Uhrzeit der letzten Änderung des Anwenderdatensatzes. Datentyp: Zeichenfolge
meta.location	URI des abgerufenen Anwenders. Datentyp: Zeichenfolge
meta.resourceType	Ressourcentyp der SCIM-Anwender. Datentyp: Zeichenfolge
name	Informationen zum Namen des Benutzers. Datentyp: Objekt "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" }
Name.Familienname	Familien- oder Nachname des Anwenders. Datentyp: Zeichenfolge
Name.Vorname	Vor- oder Vorname des Anwenders. Datentyp: Zeichenfolge
name.honorificPrefix	Ehrungsname oder -titel des Anwenders, z. B. Dr., Bistum oder Vendor. Datentyp: Zeichenfolge
Name.Mitte	Zweiter Vorname des Anwenders. 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 Anwenders. Datentyp: Zeichenfolge
Schemas	Liste der URIs der SCIM-Anwenderschemata, die zur Verarbeitung der Anforderung verwendet werden. Datentyp: Array von Zeichenfolgen
Feld	Zeitzone des Benutzers. Datentyp: Zeichenfolge
Titel	Titel des Anwenders, z. B. CEO oder President. Datentyp: Zeichenfolge
userName	Eindeutiger Anwendername für den zugeordneten Anwender. Datentyp: Zeichenfolge
userType	Benutzertyp Dieser Wert wird verwendet, um die Beziehung zwischen Organisation und Anwender zu identifizieren. Dies kann ein beliebiger Wert sein. Typische Werte sind jedoch: 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" }
company.display	Name des Unternehmens. Datentyp: Zeichenfolge
Unternehmenswert	Sys_id des Unternehmensdatensatzes. Datentyp: Zeichenfolge
Unternehmen.$ref	Referenz-URI für das Unternehmen. Datentyp: Zeichenfolge
Kostenstelle	Details zur Kostenstelle des Benutzers. Datentyp: Objekt "costCenter": { "display": "String", "value": "String", "$ref": "String" }
Kostenstelle.Anzeige	Name der Kostenstelle. Datentyp: Zeichenfolge
Kostenstelle.Wert	Sys_id des Kostenstellen-Datensatzes. Datentyp: Zeichenfolge
Kostenstelle.$ref	Referenz-URI für die Kostenstelle. Datentyp: Zeichenfolge
department	Details zur Abteilung des Anwenders. Datentyp: Objekt "department": { "display": "String", "value": "String", "$ref": "String" }
abteilung.anzeigen	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 Anwenders, z. B. männlich oder weib. Datentyp: Zeichenfolge
location	Details zum zugeordneten Standort des Anwenders. Datentyp: Objekt "location": { "display": "String", "value": "String", "$ref": "String" }
location.display	Name des Standorts. Datentyp: Zeichenfolge
location.value	Sys_id des Standortdatensatzes. Datentyp: Zeichenfolge
location.$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.wert	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 angegebenen Such- und Massenänderungsfunktionen werden von diesem Endpunkt nicht unterstützt.

URL-Format

URL mit Versionsnummer: /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, sofern excludedAttributes nicht angegeben ist.
ausgeschlosseneAttribute	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 Anwender innerhalb der Instanz ServiceNow aktiv ist. Mögliche Werte: wahr: Anwender ist aktiv. „falsch“: Anwender ist inaktiv. Datentyp: Boolesch
addresses	Details zur aktuellen Postanschrift des Anwenders. Datentyp: Objekt "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" }
adressen.land	Ländername. Datentyp: Zeichenfolge
Adressen.Ort	Name der Stadt oder des Ortes. Datentyp: Zeichenfolge
adressen.postleitzahl	Postleitzahl. Datentyp: Zeichenfolge
adressen.region	Bundesland oder Region. Datentyp: Zeichenfolge
adressen.straßenadresse	Vollständige Adresse mit Straße und Hausnummer. Dies kann die Hausnummer, der Straßenname, das Postfach und mehrzeilige erweiterte Straßeninformationen enthalten. Datentyp: Zeichenfolge
adressen.type	Typ der Adresse Unterstützt derzeit nur Homepagevon. Datentyp: Zeichenfolge
displayName	Anzeigename des Anwenders. Dieser Wert wird durch Verketten der Felder name automatisch generiert. Datentyp: Zeichenfolge
E-Mails	Liste der E-Mail-Accounts, die dem Anwender zugeordnet sind. Datentyp: Array von Objekten "emails:" [ { "type": "String", "value": "String" } ]
emails.type	E-Mail-Typ des Anwenders. Unterstützt derzeit nur den Typ „Arbeit“. Datentyp: Zeichenfolge
emails.value	E-Mail-Adresse des Anwenders. Dies ist ein eindeutiger Schlüssel für den zugeordneten Anwender. Datentyp: Zeichenfolge
externalId	Eindeutiger Bezeichner, der dem Anwender von der bereitstellenden Entität zugewiesen wurde. Datentyp: Zeichenfolge
name	Informationen zum Namen des Benutzers. Datentyp: Objekt "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" }
Name.Familienname	Familien- oder Nachname des Anwenders. Datentyp: Zeichenfolge
Name.Vorname	Vor- oder Vorname des Anwenders. Datentyp: Zeichenfolge
name.honorificPrefix	Ehrungsname oder -titel des Anwenders, z. B. Dr., Bistum oder Vendor. Datentyp: Zeichenfolge
Name.Mitte	Zweiter Vorname des Anwenders. 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 Anwenders. Datentyp: Zeichenfolge
Feld	Zeitzone des Benutzers. Datentyp: Zeichenfolge
Titel	Titel des Anwenders, z. B. CEO oder President. Datentyp: Zeichenfolge
userName	Erforderlich. Eindeutiger Anwendername für den zugeordneten Anwender. Datentyp: Zeichenfolge
userType	Benutzertyp Dieser Wert wird verwendet, um die Beziehung zwischen Organisation und Anwender zu identifizieren. Dies kann ein beliebiger Wert sein. Typische Werte sind jedoch: Vertragsunternehmen Mitarbeiter Praktikanten Temp Extern Unbekannt Datentyp: Zeichenfolge
Erweitertes Schema
Unternehmen	Details zum zugeordneten Unternehmen des Benutzers. Datentyp: Objekt "company": { "value": "String" }
Unternehmenswert	Erforderlich, wenn das Unternehmen im Beitrag enthalten ist. Sys_id des Unternehmensdatensatzes. Datentyp: Zeichenfolge
Kostenstelle	Details zur Kostenstelle des Benutzers. Datentyp: Objekt "costCenter": { "value": "String" }
Kostenstelle.Wert	Erforderlich, wenn Kostenstelle in der Veröffentlichung enthalten ist. Sys_id des Kostenstellen-Datensatzes. Datentyp: Zeichenfolge
department	Details zur Abteilung des Anwenders. Datentyp: Objekt "department": { "value": "String" }
abteilung.wert	Erforderlich, wenn Abteilung im Beitrag enthalten ist. Sys_id des Abteilungsdatensatzes. Datentyp: Zeichenfolge
employeeNumber	Numerische oder alphanumerische Mitarbeiternummer. Datentyp: Zeichenfolge
Geschlecht	Geschlecht des Anwenders, z. B. männlich oder weib. Datentyp: Zeichenfolge
location	Details zum zugeordneten Standort des Anwenders. Datentyp: Objekt "location": { "value": "String" }
location.value	Erforderlich, wenn Standort im Beitrag enthalten ist. Sys_id des Standortdatensatzes. Datentyp: Zeichenfolge
Manager	Details zum zugeordneten Manager des Benutzers. Datentyp: Objekt "manager": { "value": "String" }
manager.wert	Erforderlich, wenn Manager im Beitrag 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.

Parameter des Antworttexts (JSON oder XML)

Name	Beschreibung
aktiv	Kennzeichnung, die angibt, ob der zugeordnete Anwender innerhalb der Instanz ServiceNow aktiv ist. Mögliche Werte: wahr: Anwender ist aktiv. „falsch“: Anwender ist inaktiv. Datentyp: Boolesch
addresses	Details zur aktuellen Postanschrift des Anwenders. Datentyp: Objekt "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" }
adressen.land	Ländername. Datentyp: Zeichenfolge
Adressen.Ort	Name der Stadt oder des Ortes. Datentyp: Zeichenfolge
adressen.postleitzahl	Postleitzahl. Datentyp: Zeichenfolge
adressen.region	Bundesland oder Region. Datentyp: Zeichenfolge
adressen.straßenadresse	Vollständige Adresse mit Straße und Hausnummer. Dies kann die Hausnummer, der Straßenname, das Postfach und mehrzeilige erweiterte Straßeninformationen enthalten. Datentyp: Zeichenfolge
adressen.type	Typ der Adresse Unterstützt derzeit nur Homepagevon. Datentyp: Zeichenfolge
displayName	Anzeigename des Anwenders. Dieser Wert wird durch Verketten der Felder name automatisch generiert. Datentyp: Zeichenfolge
E-Mails	Liste der E-Mail-Accounts, die dem Anwender zugeordnet sind. Datentyp: Array von Objekten "emails:" [ { "type": "String", "value": "String" } ]
emails.type	E-Mail-Typ des Anwenders. Unterstützt derzeit nur den Typ „Arbeit“. Datentyp: Zeichenfolge
emails.value	E-Mail-Adresse des Anwenders. Dies ist ein eindeutiger Schlüssel für den zugeordneten Anwender. Datentyp: Zeichenfolge
Fehler	Antwort, die alle Fehler beschreibt, die während der Verarbeitung der Anforderung aufgetreten sind. Datentyp: Objekt "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" }
Fehler.detail	Detaillierte Fehlermeldung, warum die Anforderung fehlgeschlagen ist. Datentyp: Zeichenfolge
Fehler.scimType	SCIM-Fehlerdetailstichwort. Datentyp: Zeichenfolge
Fehler.Schemata	URI der SCIM-Schemas, die zur Verarbeitung der Fehlerantwort verwendet werden. Datentyp: Array von Zeichenfolgen
Fehler.Status	HTTP-Statuscode für die Fehlerantwort. Datentyp: Zeichenfolge
externalId	Eindeutiger Bezeichner, der dem Anwender von der bereitstellenden Entität zugewiesen wurde. Datentyp: Zeichenfolge
groups	Liste der Gruppen, denen der Anwender angehört, entweder über direkte Mitgliedschaft, über geschachtelte Gruppen oder dynamisch berechnet. Datentyp: Array von Objekten "groups": [ { "display": "String", "type": "String", "value": "String", "$ref": "String" } ]
gruppen.anzeigen	Name der zugeordneten Gruppe. Datentyp: Zeichenfolge
Gruppen.Typ	Typ der Gruppenzuordnung, z. B. direkt oder indirekt. Datentyp: Zeichenfolge
gruppen.wert	Sys_id eines zugeordneten Gruppendatensatzes. Datentyp: Zeichenfolge
Gruppen.$ref	URI der zugeordneten Gruppe. Datentyp: Zeichenfolge
id	Sys_id des zugeordneten Anwenderdatensatzes. Datentyp: Zeichenfolge
meta	Metadaten, die sich auf den Anwender beziehen. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
meta.created	Datum und Uhrzeit der Erstellung des Anwenderdatensatzes. Datentyp: Zeichenfolge
meta.lastModified	Datum und Uhrzeit der letzten Änderung des Anwenderdatensatzes. Datentyp: Zeichenfolge
meta.location	URI des abgerufenen Anwenders. Datentyp: Zeichenfolge
meta.resourceType	Ressourcentyp der SCIM-Anwender. Datentyp: Zeichenfolge
name	Informationen zum Namen des Benutzers. Datentyp: Objekt "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" }
Name.Familienname	Familien- oder Nachname des Anwenders. Datentyp: Zeichenfolge
Name.Vorname	Vor- oder Vorname des Anwenders. Datentyp: Zeichenfolge
name.honorificPrefix	Ehrungsname oder -titel des Anwenders, z. B. Dr., Bistum oder Vendor. Datentyp: Zeichenfolge
Name.Mitte	Zweiter Vorname des Anwenders. 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 Anwenders. Datentyp: Zeichenfolge
Schemas	Liste der URIs der SCIM-Anwenderschemata, die zur Verarbeitung der Anforderung verwendet werden. Datentyp: Array von Zeichenfolgen
Feld	Zeitzone des Benutzers. Datentyp: Zeichenfolge
Titel	Titel des Anwenders, z. B. CEO oder President. Datentyp: Zeichenfolge
userName	Eindeutiger Anwendername für den zugeordneten Anwender. Datentyp: Zeichenfolge
userType	Benutzertyp Dieser Wert wird verwendet, um die Beziehung zwischen Organisation und Anwender zu identifizieren. Dies kann ein beliebiger Wert sein. Typische Werte sind jedoch: Vertragsunternehmen Mitarbeiter Praktikanten Temp Extern Unbekannt Datentyp: Zeichenfolge

cURL-Anforderung an POST-Anwender

In diesem Beispiel wird gezeigt, wie der Anwender „Jack Sparrow“ in die Tabelle „Benutzer“ [sys_user] gesendet wird.

curl -X POST \
  https://instance-servicenow.com/api/now/scim/Users \
  -d '{
    "schemas": [
        "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User",
        "urn:ietf:params:scim:schemas:core:2.0:User"
    ],
    "externalId": "123456",
    "userName": "jack.sparrow",
    "name": {
        "familyName": "Sparrow",
        "givenName": "Jack"
    },
    "title": "Senior Developer",
    "preferredLanguage": "en",
    "timezone": "ET",
    "active": true,
    "emails": [
      {
        "value": "[e-mail]",
        "display": null,
        "type": "work",
        "primary": true
      }
    ],
    "phoneNumbers": [
      {
        "value": "9977553312",
        "type": "mobile",
        "primary": true
      }
    ]
}'

Antwort

{"schemas":
  [
    "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User",
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "id":"d6287d7b1bbe3010593876a61a4bcbc3",
  "externalId":"123456",
  "meta":{
    "resourceType":"User",
    "created":"2021-10-01T16:46:48Z",
    "lastModified":"2021-10-01T16:46:48Z",
    "location":"https://instance-servicenow.com/api/now/scim/Users/d6287d7b1bbe3010593876a61a4bcbc3"
  },
  "userName":"jack.sparrow",
  "name":{
    "familyName":"Sparrow",
    "givenName":"Jack"
  },
  "displayName":"Jack Sparrow",
  "title":"Senior Developer",
  "preferredLanguage":"en",
  "timezone":"ET",
  "active":true,
  "emails":[
    {
      "value":"[e-mail]",
      "type":"work"
    }
  ],
  "phoneNumbers":[
    {
      "value":"9977553312",
      "type":"mobile"
    }
  ]
}

SCIM – PUT /scim/Users/{user_id}

Aktualisiert den angegebenen Anwenderdatensatz in der Anwendertabelle [sys_user] einer Instanz ServiceNow unter Verwendung des SCIM-Protokolls (System for Cross-Domain Identity Management).

URL-Format

URL mit Versionsnummer: /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 Anwenderdatensatzes.

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, sofern excludedAttributes nicht angegeben ist.
ausgeschlosseneAttribute	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. Parameter des Anforderungstexts (JSON)

Name	Beschreibung
aktiv	Kennzeichnung, die angibt, ob der zugeordnete Anwender innerhalb der Instanz ServiceNow aktiv ist. Mögliche Werte: wahr: Anwender ist aktiv. „falsch“: Anwender ist inaktiv. Datentyp: Boolesch
addresses	Details zur aktuellen Postanschrift des Anwenders. Datentyp: Objekt "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" }
adressen.land	Ländername. Datentyp: Zeichenfolge
Adressen.Ort	Name der Stadt oder des Ortes. Datentyp: Zeichenfolge
adressen.postleitzahl	Postleitzahl. Datentyp: Zeichenfolge
adressen.region	Bundesland oder Region. Datentyp: Zeichenfolge
adressen.straßenadresse	Vollständige Adresse mit Straße und Hausnummer. Dies kann die Hausnummer, der Straßenname, das Postfach und mehrzeilige erweiterte Straßeninformationen enthalten. Datentyp: Zeichenfolge
adressen.type	Typ der Adresse Unterstützt derzeit nur Homepagevon. Datentyp: Zeichenfolge
displayName	Anzeigename des Anwenders. Dieser Wert wird durch Verketten der Felder name automatisch generiert. Datentyp: Zeichenfolge
E-Mails	Liste der E-Mail-Accounts, die dem Anwender zugeordnet sind. Datentyp: Array von Objekten "emails:" [ { "type": "String", "value": "String" } ]
emails.type	E-Mail-Typ des Anwenders. Unterstützt derzeit nur den Typ „Arbeit“. Datentyp: Zeichenfolge
emails.value	E-Mail-Adresse des Anwenders. Dies ist ein eindeutiger Schlüssel für den zugeordneten Anwender. Datentyp: Zeichenfolge
externalId	Eindeutiger Bezeichner, der dem Anwender von der bereitstellenden Entität zugewiesen wurde. Datentyp: Zeichenfolge
name	Informationen zum Namen des Benutzers. Datentyp: Objekt "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" }
Name.Familienname	Familien- oder Nachname des Anwenders. Datentyp: Zeichenfolge
Name.Vorname	Vor- oder Vorname des Anwenders. Datentyp: Zeichenfolge
name.honorificPrefix	Ehrungsname oder -titel des Anwenders, z. B. Dr., Bistum oder Vendor. Datentyp: Zeichenfolge
Name.Mitte	Zweiter Vorname des Anwenders. 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 Anwenders. Datentyp: Zeichenfolge
Feld	Zeitzone des Benutzers. Datentyp: Zeichenfolge
Titel	Titel des Anwenders, z. B. CEO oder President. Datentyp: Zeichenfolge
userName	Erforderlich. Eindeutiger Anwendername für den zugeordneten Anwender. Datentyp: Zeichenfolge
userType	Benutzertyp Dieser Wert wird verwendet, um die Beziehung zwischen Organisation und Anwender zu identifizieren. Dies kann ein beliebiger Wert sein. Typische Werte sind jedoch: Vertragsunternehmen Mitarbeiter Praktikanten Temp Extern Unbekannt Datentyp: Zeichenfolge
Erweitertes Schema
Unternehmen	Details zum zugeordneten Unternehmen des Benutzers. Datentyp: Objekt "company": { "value": "String" }
Unternehmenswert	Erforderlich, wenn das Unternehmen im Beitrag enthalten ist. Sys_id des Unternehmensdatensatzes. Datentyp: Zeichenfolge
Kostenstelle	Details zur Kostenstelle des Benutzers. Datentyp: Objekt "costCenter": { "value": "String" }
Kostenstelle.Wert	Erforderlich, wenn Kostenstelle in der Veröffentlichung enthalten ist. Sys_id des Kostenstellen-Datensatzes. Datentyp: Zeichenfolge
department	Details zur Abteilung des Anwenders. Datentyp: Objekt "department": { "value": "String" }
abteilung.wert	Erforderlich, wenn Abteilung im Beitrag enthalten ist. Sys_id des Abteilungsdatensatzes. Datentyp: Zeichenfolge
employeeNumber	Numerische oder alphanumerische Mitarbeiternummer. Datentyp: Zeichenfolge
Geschlecht	Geschlecht des Anwenders, z. B. männlich oder weib. Datentyp: Zeichenfolge
location	Details zum zugeordneten Standort des Anwenders. Datentyp: Objekt "location": { "value": "String" }
location.value	Erforderlich, wenn Standort im Beitrag enthalten ist. Sys_id des Standortdatensatzes. Datentyp: Zeichenfolge
Manager	Details zum zugeordneten Manager des Benutzers. Datentyp: Objekt "manager": { "value": "String" }
manager.wert	Erforderlich, wenn Manager im Beitrag 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 Anwender innerhalb der Instanz ServiceNow aktiv ist. Mögliche Werte: wahr: Anwender ist aktiv. „falsch“: Anwender ist inaktiv. Datentyp: Boolesch
addresses	Details zur aktuellen Postanschrift des Anwenders. Datentyp: Objekt "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" }
adressen.land	Ländername. Datentyp: Zeichenfolge
Adressen.Ort	Name der Stadt oder des Ortes. Datentyp: Zeichenfolge
adressen.postleitzahl	Postleitzahl. Datentyp: Zeichenfolge
adressen.region	Bundesland oder Region. Datentyp: Zeichenfolge
adressen.straßenadresse	Vollständige Adresse mit Straße und Hausnummer. Dies kann die Hausnummer, der Straßenname, das Postfach und mehrzeilige erweiterte Straßeninformationen enthalten. Datentyp: Zeichenfolge
adressen.type	Typ der Adresse Unterstützt derzeit nur Homepagevon. Datentyp: Zeichenfolge
displayName	Anzeigename des Anwenders. Dieser Wert wird durch Verketten der Felder name automatisch generiert. Datentyp: Zeichenfolge
E-Mails	Liste der E-Mail-Accounts, die dem Anwender zugeordnet sind. Datentyp: Array von Objekten "emails:" [ { "type": "String", "value": "String" } ]
emails.type	E-Mail-Typ des Anwenders. Unterstützt derzeit nur den Typ „Arbeit“. Datentyp: Zeichenfolge
emails.value	E-Mail-Adresse des Anwenders. Dies ist ein eindeutiger Schlüssel für den zugeordneten Anwender. Datentyp: Zeichenfolge
Fehler	Antwort, die alle Fehler beschreibt, die während der Verarbeitung der Anforderung aufgetreten sind. Datentyp: Objekt "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" }
Fehler.detail	Detaillierte Fehlermeldung, warum die Anforderung fehlgeschlagen ist. Datentyp: Zeichenfolge
Fehler.scimType	SCIM-Fehlerdetailstichwort. Datentyp: Zeichenfolge
Fehler.Schemata	URI der SCIM-Schemas, die zur Verarbeitung der Fehlerantwort verwendet werden. Datentyp: Array von Zeichenfolgen
Fehler.Status	HTTP-Statuscode für die Fehlerantwort. Datentyp: Zeichenfolge
externalId	Eindeutiger Bezeichner, der dem Anwender von der bereitstellenden Entität zugewiesen wurde. Datentyp: Zeichenfolge
groups	Liste der Gruppen, denen der Anwender angehört, entweder über direkte Mitgliedschaft, über geschachtelte Gruppen oder dynamisch berechnet. Datentyp: Array von Objekten "groups": [ { "display": "String", "type": "String", "value": "String", "$ref": "String" } ]
gruppen.anzeigen	Name der zugeordneten Gruppe. Datentyp: Zeichenfolge
Gruppen.Typ	Typ der Gruppenzuordnung, z. B. direkt oder indirekt. Datentyp: Zeichenfolge
gruppen.wert	Sys_id eines zugeordneten Gruppendatensatzes. Datentyp: Zeichenfolge
Gruppen.$ref	URI der zugeordneten Gruppe. Datentyp: Zeichenfolge
id	Sys_id des zugeordneten Anwenderdatensatzes. Datentyp: Zeichenfolge
meta	Metadaten, die sich auf den Anwender beziehen. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
meta.created	Datum und Uhrzeit der Erstellung des Anwenderdatensatzes. Datentyp: Zeichenfolge
meta.lastModified	Datum und Uhrzeit der letzten Änderung des Anwenderdatensatzes. Datentyp: Zeichenfolge
meta.location	URI des abgerufenen Anwenders. Datentyp: Zeichenfolge
meta.resourceType	Ressourcentyp der SCIM-Anwender. Datentyp: Zeichenfolge
name	Informationen zum Namen des Benutzers. Datentyp: Objekt "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" }
Name.Familienname	Familien- oder Nachname des Anwenders. Datentyp: Zeichenfolge
Name.Vorname	Vor- oder Vorname des Anwenders. Datentyp: Zeichenfolge
name.honorificPrefix	Ehrungsname oder -titel des Anwenders, z. B. Dr., Bistum oder Vendor. Datentyp: Zeichenfolge
Name.Mitte	Zweiter Vorname des Anwenders. 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 Anwenders. Datentyp: Zeichenfolge
Schemas	Liste der URIs der SCIM-Anwenderschemata, die zur Verarbeitung der Anforderung verwendet werden. Datentyp: Array von Zeichenfolgen
Feld	Zeitzone des Benutzers. Datentyp: Zeichenfolge
Titel	Titel des Anwenders, z. B. CEO oder President. Datentyp: Zeichenfolge
userName	Eindeutiger Anwendername für den zugeordneten Anwender. Datentyp: Zeichenfolge
userType	Benutzertyp Dieser Wert wird verwendet, um die Beziehung zwischen Organisation und Anwender zu identifizieren. Dies kann ein beliebiger Wert sein. Typische Werte sind jedoch: 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" }
company.display	Name des Unternehmens. Datentyp: Zeichenfolge
Unternehmenswert	Sys_id des Unternehmensdatensatzes. Datentyp: Zeichenfolge
Unternehmen.$ref	Referenz-URI für das Unternehmen. Datentyp: Zeichenfolge
Kostenstelle	Details zur Kostenstelle des Benutzers. Datentyp: Objekt "costCenter": { "display": "String", "value": "String", "$ref": "String" }
Kostenstelle.Anzeige	Name der Kostenstelle. Datentyp: Zeichenfolge
Kostenstelle.Wert	Sys_id des Kostenstellen-Datensatzes. Datentyp: Zeichenfolge
Kostenstelle.$ref	Referenz-URI für die Kostenstelle. Datentyp: Zeichenfolge
department	Details zur Abteilung des Anwenders. Datentyp: Objekt "department": { "display": "String", "value": "String", "$ref": "String" }
abteilung.anzeigen	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 Anwenders, z. B. männlich oder weib. Datentyp: Zeichenfolge
location	Details zum zugeordneten Standort des Anwenders. Datentyp: Objekt "location": { "display": "String", "value": "String", "$ref": "String" }
location.display	Name des Standorts. Datentyp: Zeichenfolge
location.value	Sys_id des Standortdatensatzes. Datentyp: Zeichenfolge
location.$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.wert	Sys_id des Manager-Datensatzes. Datentyp: Zeichenfolge
manager.$ref	Referenz-URI für den Manager. Datentyp: Zeichenfolge

cURL-Anforderung zum Aktualisieren von Anwenderinformationen mit PUT

In diesem Beispiel wird gezeigt, wie Sie die Informationen eines vorhandenen Anwenders mit dem PUT-Endpunkt aktualisieren.

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 Ressourcentypen des Systems für domänenübergreifendes Identitätsmanagement (SCIM) ab, die von der zugeordneten Instanz ServiceNow unterstützt werden.

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

URL-Format

URL mit Versionsnummer: /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. Parameter des Anforderungstexts (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
itemProPage	Anzahl der in den Rückgabeergebnissen zurückgegebenen Datensätze. Datentyp: Zahl
Ressourcen	Liste der verfügbaren Ressourcentypen. Datentyp: Array von Objekten "Resources": [ { "description": "String", "endpoint": "String", "id": "String", "meta": {Object}, "name": "String", "schema": "String" "schemas": [Array], "schemaExtensions": [Array] } ]
Resources.description	Kurze Beschreibung des Ressourcentyps. Datentyp: Zeichenfolge
Ressourcen.Endpunkt	Name des über HTTP adressierbaren Endpunkts relativ zur Basis-URL des Service Providers, z. B. „Anwender“. Datentyp: Zeichenfolge
Resources.id	Eindeutiger Bezeichner für die Ressource. Verwenden Sie dieses Attribut, wenn Sie den Endpunkt „GET /scim/ResourceType/{resource_id}“ aufrufen. Datentyp: Zeichenfolge
Resources.meta	Informationen, die die zugeordnete Ressource genauer 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 „Ressourcentyp“. 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	Zur Verarbeitung der /ResourceType- Anforderung verwendetes Schema. 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" }
Ressourcen.schemaerweiterungen.erforderlich	Kennzeichnung, die angibt, ob die Schemaerweiterung für den Ressourcentyp erforderlich ist. Mögliche Werte: „wahr“: Eine Ressource dieses Typs muss diese Schemaerweiterung sowie alle Attribute enthalten, die in dieser Schemaerweiterung als erforderlich deklariert wurden. „falsch“: Eine Ressource dieses Typs kann diese Schemaerweiterung auslassen. Datentyp: Boolesch
Resources.schemaExtensions.schema (Ressourcen.schemaErweiterungen.schema)	URI eines erweiterten Schemas. Beispiel: "urn:ietf:params:scim:schemas:extension: servicenow:2.0:User". Datentyp: Zeichenfolge
Schemas	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 die 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 abrufen.

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/{RessourceName}

Ruft Informationen zum angegebenen System für den Ressourcentyp des domänenübergreifenden Identitätsmanagements (SCIM) ab.

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

URL-Format

URL mit Versionsangabe: /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 Anwender Datentyp: Zeichenfolge

Tabelle : 92. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 93. Parameter des Anforderungstexts (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 Bezeichner für die Ressource. Verwenden Sie dieses Attribut, wenn Sie den Endpunkt „GET /scim/ResourceType/{resource_id}“ aufrufen. Datentyp: Zeichenfolge
meta	Informationen, die die zugeordnete Ressource genauer beschreiben. Datentyp: Objekt "metadata": { "location": "String", "resourceType": "String" }
meta.location	URI des zugeordneten Ressourcentyps in der zugeordneten Instanz ServiceNow Datentyp: Zeichenfolge
meta.resourceType	Immer „Ressourcentyp“. 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
Schemas	Zur Verarbeitung der /ResourceType- Anforderung verwendetes Schema. 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: „wahr“: Eine Ressource dieses Typs muss diese Schemaerweiterung sowie alle Attribute enthalten, die in dieser Schemaerweiterung als erforderlich deklariert wurden. „falsch“: Eine Ressource dieses Typs kann diese Schemaerweiterung auslassen. Datentyp: Boolesch
schemaErweiterungen.schema	URI eines erweiterten Schemas. Beispiel: "urn:ietf:params:scim:schemas:extension: servicenow:2.0:User". Datentyp: Zeichenfolge
Schemas	Schema, das 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 Sie den Ressourcentyp User SCIM aus einer ServiceNow -Instanz abrufen.

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-Ressourcenschemata (System für domänenübergreifendes Identitätsmanagement) ab, die von einer Instanz ServiceNow unterstützt werden. Diese Schemas definieren die Attribute, die für jeden Ressourcentyp verfügbar sind.

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

URL-Format

URL mit Versionsnummer: /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. Parameter des Anforderungstexts (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
RFC7643-Standardrückgabeergebnisse	Die Methode gibt Ergebnisse zurück, die dem RFC7643-Standard entsprechen. Einzelheiten finden Sie unter Schemadefinition in der Spezifikation RFC7643.

cURL-Anforderung

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

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 zum angegebenen System für SCIM-Ressourcenschemas (Cross-Domain Identity Management) ab, die von einer Instanz ServiceNow unterstützt werden. Diese Schemas definieren die Attribute, die für jeden Ressourcentyp verfügbar sind.

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

URL-Format

URL mit Versionsnummer: /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:User urn:ietf:params:scim:schemas:extension: Enterprise:2.0:User urn:ietf:params:scim:schemas:extension: servicenow:2.0:User urn:ietf:params:scim:schemas:core:2.0:Gruppe urn:ietf:params:scim:schemas:custom: servicenow:2.0:Company urn:ietf:params:scim:schemas:custom: servicenow:2.0:Abteilung urn:ietf:params:scim:schemas:custom: servicenow:2.0:CostCenter urn:ietf:params:scim:schemas:custom: servicenow:2.0:Ort Datentyp: Zeichenfolge

Tabelle : 104. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 105. Parameter des Anforderungstexts (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
RFC7643-Standardrückgabeergebnisse	Die Methode gibt Ergebnisse zurück, die dem RFC7643-Standard entsprechen. Einzelheiten finden Sie unter Schemadefinition in der Spezifikation RFC7643.

cURL-Anforderung

Das folgende Beispiel zeigt, wie das SCIM-Kernschema der Gruppe von 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 Endpunkte des Systems für domänenübergreifendes Identitätsmanagement (SCIM) abgerufen werden sollen, die in einer Instanz ServiceNow verfügbar sind.

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

URL-Format

URL mit Versionsnummer: /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. Parameter des Anforderungstexts (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
RFC7643-Standardrückgabeergebnisse	Die Methode gibt Ergebnisse zurück, die dem RFC7643-Standard entsprechen. Einzelheiten hierzu finden Sie unter Konfigurationsschema für Service Provider in der Spezifikation RFC7643.

cURL-Anforderung

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

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] innerhalb 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 eine Erfolgsmeldung (HTTP-Statuscode 200) zurück, wobei totalResults auf 0 festgelegt ist.

URL-Format

URL mit Versionsnummer: /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, sofern excludedAttributes nicht angegeben ist.
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 für eine schwerwiegende Anforderung. Standard: 10
ausgeschlosseneAttribute	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">. Eine Liste der gültigen Operatoren finden Sie unter RFC7644. 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 geschachtelte 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 zwischen Groß- und Kleinschreibung unterschieden. Sie können nur die Parameter verwenden, die zum Filtern für den Parameter sortBy verfügbar sind, außer dass externalId nicht zulässig ist. Für Werte, die NULL sind: aufsteigend sortiert: Null-Werte werden oben sortiert. in absteigender Reihenfolge sortiert: Null-Werte werden 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	Einsbasierter Index in die Tabelle, ab der das Abrufen von Datensätzen beginnen 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. Parameter des Anforderungstexts (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 filter -Parameter gültig sind.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
itemProPage	Anzahl der in den Rückgabeergebnissen zurückgegebenen Datensätze. Datentyp: Zahl
Ressourcen	Liste der zurückgegebenen Kostenstellen-Datensä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" }
Ressourcen.Meta.Erstellt	Datum und Uhrzeit der Erstellung des zugehörigen Unternehmensdatensatzes. Datentyp: Zeichenfolge
Resources.meta.lastModified	Zeitpunkt (Datum und Uhrzeit), zu dem der zugeordnete Unternehmensdatensatz zuletzt geändert wurde. 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
Schemas	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 die Tabelle „Unternehmen“ [core_company], in der die Datensätze zurückgegeben wurden. Datentyp: Zeichenfolge
totalResults	Gesamtzahl der Datensätze, die der Anforderung entsprechen. Datentyp: Zahl

cURL-Anforderung

In diesem Beispiel wird gezeigt, 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] innerhalb einer Instanz ServiceNow unter Verwendung des SCIM-Protokolls (System for Cross-Domain Identity Management) zurück.

URL-Format

URL mit Versionsnummer: /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, sofern excludedAttributes nicht angegeben ist.
ausgeschlosseneAttribute	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. Parameter des Anforderungstexts (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 filter -Parameter 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 zugehörigen Unternehmensdatensatzes. Datentyp: Zeichenfolge
meta.lastModified	Zeitpunkt (Datum und Uhrzeit), zu dem der zugeordnete Unternehmensdatensatz zuletzt geändert wurde. Datentyp: Zeichenfolge
meta.location	URI des zugeordneten Unternehmensdatensatzes. Datentyp: Zeichenfolge
meta.resourceType	SCIM-Ressourcentyp; Immer Unternehmen Datentyp: Zeichenfolge
name	Unternehmensname. Datentyp: Zeichenfolge
Schemas	Bei der Verarbeitung der Anforderung verwendetes Schema. Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel wird gezeigt, 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 Kostenstellen-Datensätze aus der Kostenstellen-Tabelle [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 eine Erfolgsmeldung (HTTP-Statuscode 200) zurück, wobei totalResults auf 0 festgelegt ist.

URL-Format

URL mit Versionsnummer: /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, sofern excludedAttributes nicht angegeben ist.
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 für eine schwerwiegende Anforderung. Standard: 10
ausgeschlosseneAttribute	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">. Eine Liste der gültigen Operatoren finden Sie unter RFC7644. 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 geschachtelte 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 zwischen Groß- und Kleinschreibung unterschieden. Sie können nur die Parameter verwenden, die zum Filtern für den Parameter sortBy verfügbar sind, außer dass externalId nicht zulässig ist. Für Werte, die NULL sind: aufsteigend sortiert: Null-Werte werden oben sortiert. in absteigender Reihenfolge sortiert: Null-Werte werden 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	Einsbasierter Index in die Tabelle, ab der das Abrufen von Datensätzen beginnen 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 filter -Parameter gültig sind.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
itemProPage	Anzahl der in den Rückgabeergebnissen zurückgegebenen Datensätze. Datentyp: Zahl
Ressourcen	Liste der zurückgegebenen Kostenstellen-Datensä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 Kostenstellen-Datensatz. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" }
Ressourcen.Meta.Erstellt	Datum und Uhrzeit der Erstellung des zugehörigen Kostenstellen-Datensatzes. Datentyp: Zeichenfolge
Resources.meta.lastModified	Datum und Uhrzeit der letzten Änderung des zugehörigen Kostenstellen-Datensatzes. 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
Schemas	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 die Kostenstellentabelle [cmn_cost_center], in der die Datensätze zurückgegeben wurden. Datentyp: Zeichenfolge
totalResults	Gesamtzahl der Datensätze, die der Anforderung entsprechen. Datentyp: Zahl

cURL-Anforderung

In diesem Beispiel wird gezeigt, wie die ersten beiden Kostenstellen-Datensä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 Kostenstellen-Datensatz aus der Kostenstellen-Tabelle [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 eine Erfolgsmeldung (HTTP-Statuscode 200) zurück, wobei totalResults auf 0 festgelegt ist.

URL-Format

URL mit Versionsnummer: /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
Kostenstelle_ID	Sys_id des zurückzugebenden Kostenstellen-Datensatzes. 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, sofern excludedAttributes nicht angegeben ist.
ausgeschlosseneAttribute	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. Parameter des Anforderungstexts (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 filter -Parameter 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 Kostenstellen-Datensatz. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" }
meta.created	Datum und Uhrzeit der Erstellung des zugehörigen Kostenstellen-Datensatzes. Datentyp: Zeichenfolge
meta.lastModified	Datum und Uhrzeit der letzten Änderung des zugehörigen Kostenstellen-Datensatzes. 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
Schemas	Bei der Verarbeitung der Anforderung verwendetes Schema. Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel wird gezeigt, wie ein bestimmter Kostenstellen-Datensatz 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 unter Verwendung des SCIM-Protokolls (System for Cross-Domain Identity Management) zurück.

Hinweis:

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

URL-Format

URL mit Versionsnummer: /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, sofern excludedAttributes nicht angegeben ist.
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 für eine schwerwiegende Anforderung. Standard: 10
ausgeschlosseneAttribute	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">. Eine Liste der gültigen Operatoren finden Sie unter RFC7644. Hinweis: Der NOT- Operator wird von dieser Methode nicht unterstützt. Um beispielsweise nach allen Abteilungen zu filtern, deren Name mit „Engineer“ beginnt, geben Sie displayName SW „Engineer“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 geschachtelte 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 zwischen Groß- und Kleinschreibung unterschieden. Sie können nur die Parameter verwenden, die zum Filtern für den Parameter sortBy verfügbar sind, außer dass externalId nicht zulässig ist. Für Werte, die NULL sind: aufsteigend sortiert: Null-Werte werden oben sortiert. in absteigender Reihenfolge sortiert: Null-Werte werden 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	Einsbasierter Index in die Tabelle, ab der das Abrufen von Datensätzen beginnen 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. Parameter des Anforderungstexts (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 filter -Parameter gültig sind.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
itemProPage	Anzahl der in den Rückgabeergebnissen zurückgegebenen Datensätze. Datentyp: Zahl
Ressourcen	Liste der zurückgegebenen Abteilungsdatensätze. Datentyp: Objekt "Resources": { "id": "String", "meta": {Object}, "name": "String", "schemas": "String" }
Resources.id	Sys_id des Abteilungsdatensatzes. Datentyp: Zeichenfolge
Resources.meta	Informationen zum Abteilungsdatensatz. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" }
Ressourcen.Meta.Erstellt	Datum und Uhrzeit der Erstellung des zugehörigen Abteilungsdatensatzes. Datentyp: Zeichenfolge
Resources.meta.lastModified	Zeitpunkt (Datum und Uhrzeit), zu dem 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
Schemas
startIndex	Einbasierter Index in die Tabelle „Abteilung“ [cmn_department], an die die Datensätze zurückgegeben wurden. Datentyp: Zeichenfolge
totalResults	Gesamtzahl der Datensätze, die der Anforderung entsprechen. Datentyp: Zahl

cURL-Anforderung

In diesem Beispiel wird gezeigt, 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

URL mit Versionsangabe: /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
„departement_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, sofern excludedAttributes nicht angegeben ist.
ausgeschlosseneAttribute	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. Parameter des Anforderungstexts (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 filter -Parameter 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 zugehörigen Abteilungsdatensatzes. Datentyp: Zeichenfolge
meta.lastModified	Zeitpunkt (Datum und Uhrzeit), zu dem 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
Schemas	Bei der Verarbeitung der Anforderung verwendetes Schema. Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel wird gezeigt, 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 eine Erfolgsmeldung (HTTP-Statuscode 200) zurück, wobei totalResults auf 0 festgelegt ist.

URL-Format

URL mit Versionsnummer: /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, sofern excludedAttributes nicht angegeben ist.
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 für eine schwerwiegende Anforderung. Standard: 10
ausgeschlosseneAttribute	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">. Eine Liste der gültigen Operatoren finden Sie unter RFC7644. 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“ AND meta.lastModified lt „2021-10-03T00:00:00Z“ ein. Verwenden Sie Dot-Walking, um geschachtelte 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 zwischen Groß- und Kleinschreibung unterschieden. Sie können nur die Parameter verwenden, die zum Filtern für den Parameter sortBy verfügbar sind, außer dass externalId nicht zulässig ist. Für Werte, die NULL sind: aufsteigend sortiert: Null-Werte werden oben sortiert. in absteigender Reihenfolge sortiert: Null-Werte werden 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	Einsbasierter Index in die Tabelle, ab der das Abrufen von Datensätzen beginnen 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. Parameter des Anforderungstexts (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 filter -Parameter gültig sind.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
itemProPage	Anzahl der in den Rückgabeergebnissen zurückgegebenen Datensätze. Datentyp: Zahl
Ressourcen	Liste der zurückgegebenen Standortdatensätze. Datentyp: Objekt "Resources": { "id": "String", "meta": {Object}, "name": "String", "schemas": "String" }
Resources.id	Sys_id des Standortdatensatzes. Datentyp: Zeichenfolge
Resources.meta	Informationen zum Standortdatensatz. Datentyp: Objekt "meta": { "created": "String", "lastModified": "String", "location": "String", "resourceType": "String" }
Ressourcen.Meta.Erstellt	Datum und Uhrzeit der Erstellung des zugehörigen Standortdatensatzes. Datentyp: Zeichenfolge
Resources.meta.lastModified	Zeitpunkt (Datum und Uhrzeit), zu dem der zugeordnete Standortdatensatz zuletzt geändert wurde. 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
Schemas	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 die Standorttabelle [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

In diesem Beispiel wird gezeigt, 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 Instanz ServiceNow unter Verwendung des SCIM-Protokolls (System for Cross-Domain Identity Management) zurück.

URL-Format

URL mit Versionsnummer: /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, sofern excludedAttributes nicht angegeben ist.
ausgeschlosseneAttribute	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. Parameter des Anforderungstexts (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 filter -Parameter 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 zugehörigen Standortdatensatzes. Datentyp: Zeichenfolge
meta.lastModified	Zeitpunkt (Datum und Uhrzeit), zu dem der zugeordnete Standortdatensatz zuletzt geändert wurde. Datentyp: Zeichenfolge
meta.location	URI des zugeordneten Standortdatensatzes. Datentyp: Zeichenfolge
meta.resourceType	SCIM-Ressourcentyp; immer Standort. Datentyp: Zeichenfolge
name	Standortname Datentyp: Zeichenfolge
Schemas	Bei der Verarbeitung der Anforderung verwendetes Schema. Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel wird gezeigt, 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"
}