クロスドメイン ID 管理システム (SCIM) API

クロスドメイン ID 管理システム (SCIM) API は、SCIM プロトコルを使用してユーザーとグループの操作を作成、読み取り、更新、および削除するためのエンドポイントを提供します。

SCIM プロトコルは、HTTP (RFC7230) 標準を基礎とするアプリケーションレベルの HTTP ベースプロトコルです。この API は、Web およびクロスドメイン環境 (エンタープライズからクラウドへのサービスプロバイダーやクラウド間のシナリオなど) でのユーザーやグループなどの ID データのプロビジョニングと管理に使用します。

この API にアクセスするには、SCIM v2 - ServiceNow® Cross-domain Identity Management (com.snc.integration.scim2) プラグインを有効にする必要があります。

リソースマッピング

SCIM サービスには、次の 6 つのリソースがあります。

• ユーザー (コアおよび拡張)
• グループ (コアおよび拡張)
• 会社
• CostCenter
• 部門
• 場所

これらの SCIM リソースの属性のほとんどは、既存の ServiceNow テーブルの対応するフィールドにマップされます。次のテーブルでこれらのマッピングを定義します。既存の ServiceNow テーブルのフィールドに対応しない属性は、2 つの SCIM 固有のテーブルにマップされます。これらのテーブルの詳細については、「 SCIM 固有のテーブル」を参照してください。

SCIM ユーザーリソースには、コア (schema: urn:ietf:params:scim:schemas:core:2.0:User) スキーマと拡張 (urn:ietf:params:scim:schemas:extension:servicenow:2.0:User) スキーマの両方があります。ユーザーのコアおよび拡張スキーマ属性のほとんどは、ユーザー [sys_user] テーブルにマップされます。

表 : 1. ユーザーリソースからユーザー [sys_user] テーブルへのマッピング

SCIM 属性名	ユーザーフィールド名
active	active
addresses.country	country
addresses.default.country	country
addresses.home.country	country
addresses.locality	city
addresses.default.locality	city
addresses.home.locality	city
addresses.postalCode	zip
addresses.default.postalCode	zip
addresses.home.postalCode	zip
addresses.region	state
addresses.default.region	state
addresses.home.region	state
addresses.streetAddress	street
addresses.default.streetAddress	street
addresses.home.streetAddress	street
displayName	name
emails.value	email
emails.default.value	email
emails.work.value	email
id	sys_id
meta.created	sys_created_on
meta.lastModified	sys_updated_on
name.familyName	last_name
name.givenName	first_name
name.honorificPrefix	introduction
name.middleName	middle_name
phoneNumbers.value	phone
phoneNumbers.home.value	home_phone
phoneNumbers.mobile.value	mobile_phone
phoneNumbers.work.value	phone
preferredLanguage	preferred_language
timezone	time_zone
title	title
userName	user_name

表 : 2. ユーザーリソースから Sys Scim ユーザー [sys_scim_user] テーブルへのマッピング

SCIM 属性名	Sys Scim ユーザーフィールド名
externalId	external_id

SCIM ユーザー拡張スキーマ (urn:ietf:params:scim:schemas:extension:servicenow:2.0:User) は、ユーザー [sys_user] テーブルにマップされます。

表 : 3. ユーザー拡張リソースからユーザー [sys_user] テーブルへのマッピング

SCIM 属性名	ユーザーフィールド名
company.name	company.name
company.value	company.sys_id
costCenter.name	cost_center.name
costCenter.value	cost_center.sys_id
department.name	department.name
department.value	department.sys_id
employeeNumber	employee_number
gender	gender
location.name	location.name
location.value	location.sys_id
manager.displayName	manager.name
manager.value	manager.sys_id

SCIM グループリソーススキーマ (urn:ietf:params:scim:schemas:core:2.0:Group) は、グループ [sys_user_group] テーブルにマップされます。

表 : 4. グループリソースからグループ [sys_user_group] テーブルへのマッピング

SCIM 属性名	グループフィールド名
displayName	name
id	sys_id
meta.created	sys_created_on
meta.lastModified	sys_updated_on

SCIM グループの externalId パラメーターは、Sys Scim グループ [sys_scim_group] テーブルにマップされます。

表 : 5. グループリソースから Sys Scim グループ [sys_scim_group] テーブルへのマッピング

SCIM 属性名	Sys Scim グループフィールド名
externalId	external_id

SCIM グループ ServiceNow 拡張スキーマ (urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group) は、グループ [sys_user_group] テーブルにマップされます。

表 : 6. グループリソースからグループ [sys_user_group] テーブルへのマッピング

SCIM 属性名	グループフィールド名
company.value	company.sys_id
company.name	company.name

SCIM 会社リソーススキーマ (urn:ietf:params:scim:schemas:custom:servicenow:2.0:Company) は、会社 [core_company] テーブルにマップされます。

表 : 7. 会社リソースから会社 [core_company] テーブルへのマッピング

SCIM 属性名	会社フィールド名
id	sys_id
meta.created	sys_created_on
meta.lastModified	sys_updated_on
name	name

SCIM CostCenter リソーススキーマ (urn:ietf:params:scim:schemas:custom:servicenow:2.0:CostCenter) は、コストセンター [cmn_cost_center] テーブルにマップされます。

表 : 8. CostCenter リソースからコストセンター [cmn_cost_center] テーブルへのマッピング

SCIM 属性名	コストセンターフィールド名
id	sys_id
meta.created	sys_created_on
meta.lastModified	sys_updated_on
name	name

SCIM 部門リソーススキーマ (urn:ietf:params:scim:schemas:custom:servicenow:2.0:Department) は、部門 [cmn_department] テーブルにマップされます。

表 : 9. 部門リソースから部門 [cmn_department] テーブルへのマッピング

SCIM 属性名	部門フィールド名
id	sys_id
meta.created	sys_created_on
meta.lastModified	sys_updated_on
name	name

SCIM 場所リソーススキーマ (urn:ietf:params:scim:schemas:custom:servicenow:2.0:Location) は、場所 [cmn_location] テーブルにマップされます。

表 : 10. 場所リソースから場所 [cmn_location] テーブルへのマッピング

SCIM 属性名	場所フィールド名
id	sys_id
meta.created	sys_created_on
meta.lastModified	sys_updated_on
name	name

SCIM 固有のテーブル

Sys Scim ユーザー [sys_scim_user] と Sys Scim グループ [sys_scim_group] の 2 つのテーブルには、既存の ServiceNow テーブルにマップされない SCIM 属性が含まれています。これらのテーブルの内容は次のとおりです。

表 : 11. Sys Scim ユーザー [sys_scim_user] テーブル

フィールド名	説明
作成日時	関連レコードが作成された日時。 データタイプ：文字列 最大長：40
作成者	レコードを作成したエンティティの名前。 データタイプ：文字列 最大長：40
外部 ID (External ID)	このユーザーレコードを作成したエンティティがシステム内のユーザーを参照するために使用する外部 ID。 データタイプ：文字列 最大長：255
Sys ID	ServiceNow インスタンス内のレコードの一意の識別子。 データタイプ：文字列 最大長：32
更新日時	関連レコードが最後に更新された日時。 データタイプ：文字列 最大長：40
更新者	関連レコードを最後に更新したエンティティの名前。 データタイプ：文字列 最大長：40
更新	レコードが更新された回数。 データタイプ：数値 (整数) 最大長：40
ユーザー	このレコードに関連付けられたユーザーへの参照 参照：ユーザー [sys_user] テーブル 最大長：32
ユーザータイプ	ユーザーレコードのタイプ。この値は、組織とユーザーの関係を識別するために使用されます。 これは任意の値にできますが、一般的な値には次のようなものがあります。 契約社員 従業員 外部 インターン 一時 不明 データタイプ：文字列 最大長：40

表 : 12. Sys Scim グループ [sys_scim_group] テーブル

フィールド名	説明
作成日時	関連レコードが作成された日時。 データタイプ：文字列 最大長：40
作成者	レコードを作成したエンティティの名前。 データタイプ：文字列 最大長：40
外部 ID (External ID)	このグループレコードを作成したエンティティがシステム内のグループを参照するために使用する外部 ID。 データタイプ：文字列 最大長：255
グループ	このレコードに関連付けられたグループへの参照。 参照：グループ [sys_user_group] テーブル 最大長：32
Sys ID	ServiceNow インスタンス内のレコードの一意の識別子。 データタイプ：文字列 最大長：32
更新日時	関連レコードが最後に更新された日時。 データタイプ：文字列 最大長：40
更新者	関連レコードを最後に更新したエンティティの名前。 データタイプ：文字列 最大長：40
更新	レコードが更新された回数。 データタイプ：数値 (整数) 最大長：40

ロールとアクセス制御リスト

scim_admin ロールは、SCIM 固有のテーブルとプライベート SCIM エンドポイントにアクセスするために必要です。ユーザー [sys_user] テーブルとグループ [sys_user_group] テーブルへのアクセスを可能にします。

SCIM サービスには、Sys Scim ユーザー [sys_scim_user] テーブルと Sys Scim グループ [sys_scim_group] テーブルにアクセスするための、作成、削除、読み取り、書き込みを可能にする 4 つの ACL があります。これらの ACL は、scim_admin ロールにのみマップされます。

SCIM - DELETE /scim/Groups/{group_id}

クロスドメイン ID 管理システム (SCIM) プロトコルを使用して、ServiceNow インスタンスのグループ [sys_user_group] テーブルから指定されたグループレコードを削除します。

URL 形式

バージョニングされた URL：/api/now/{api_version}/scim/Groups/{group_id}

デフォルトの URL：/api/now/scim/Groups/{group_id}

注:

利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

サポートされている要求パラメーター

表 : 13. パスパラメーター

名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列
group_id	削除するグループレコードの sys_id。 データタイプ：文字列 テーブル： Group [sys_user_group]

表 : 14. クエリパラメーター

名前	説明
なし

表 : 15. 要求本文パラメーター (JSON)

名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

表 : 16. 要求ヘッダー

ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/scim+json。 デフォルト： application/json

表 : 17. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 18. ステータスコード

ステータスコード	説明
204	コンテンツがありません。要求が正常に処理されました。
404	見つかりません。要求されたアイテムが見つかりませんでした。

応答本文のパラメーター (JSON)

名前	説明
errors	要求の処理中に発生した可能性のあるエラーを説明する応答。 データタイプ：オブジェクト "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" }
errors.detail	要求が失敗した理由に関する詳細なエラーメッセージ。 データタイプ：文字列
errors.scimType	SCIM エラーの詳細キーワード。 データタイプ：文字列
errors.schemas	エラー応答の処理に使用される SCIM スキーマの URI。 データタイプ：文字列のアレイ
errors.status	エラー応答の HTTP ステータスコード。 データタイプ：文字列

グループを削除する cURL 要求

この例は、グループ [sys_user_group] テーブルからグループレコードを削除する方法を示しています。

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

SCIM - GET /scim/Groups

クロスドメイン ID 管理システム (SCIM) プロトコルを使用して、ServiceNow インスタンス内のグループ [sys_user_group] テーブルから 1 つ以上のグループレコードを返します。

注:

一致を返さないクエリは、totalResults が 0 に設定された状態で成功 (HTTP ステータスコード 200) を返します。

URL 形式

バージョニングされた URL：/api/now/{api_version}/scim/Groups

デフォルトの URL：/api/now/scim/Groups

注:

利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

サポートされている要求パラメーター

表 : 19. パスパラメーター

名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列

表 : 20. クエリパラメーター

名前	説明
attributes	応答で返すカンマ区切りのフィールドのリストです。他のフィールドは返されません。 excludedAttributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：excludedAttributes が指定されていない限り、すべてのフィールドを返します。
count	返されるレコードの数。負の値はゼロと解釈されます。 データタイプ：数値 最大：500 - これより大きい値を指定すると、不正な要求エラーが発生します。 デフォルト：10
excludedAttributes	応答で返されるレコードから除外するフィールドのカンマ区切りのリスト。他のすべてのフィールドが返されます。 attributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：どのフィールドも除外しません。
filter	返される結果に適用するフィルター式。フィールドフィルターは、<field_name> <operator> <"value"> として表されます。有効な演算子のリストについては、RFC7644 を参照してください。 注: NOT 演算子はこのメソッドではサポートされていません。 たとえば、名前が「HR」で始まるすべてのグループをフィルタリングするには、「displayName SW "HR"」と入力します。 複数のフィールドフィルターを指定するには、AND オペランドを使用してフィルターを連結します。たとえば、名前が「HR」で始まり、最終変更日が 2021 年 10 月 3 日より前であるすべてのグループをフィルタリングするには、「displayName SW "HR" AND meta.lastModified lt "2021-10-33T00:00:00Z"」と入力します。ネストされた属性を指定するには、ドット連結を使用します。 フィルターでは、次の SCIM グループフィールドのみを使用できます。 displayName externalId：EQ 演算子のみがサポートされています。 id meta.created meta.lastModified データタイプ：文字列 デフォルト：フィルタリングなし
sortBy	sortOrder パラメーターで指定する必要があります。返される結果をソートするフィールド。ソートでは大文字と小文字が区別されません。 sortBy パラメーターのフィルタリングで利用可能なパラメーターのみを使用できます。ただし、externalId は、例外であり、許可されません。 null の値の場合： 昇順でソート:null 値は先頭にソートされます。 降順でソート:null 値は一番下にソートされます。 データタイプ：文字列 デフォルト：ソートなし
sortOrder	sortBy パラメーターで指定する必要があります。sortBy パラメーターが返される結果に適用される順序。 有効な値： 昇順 降順 データタイプ：文字列 デフォルト：昇順
startIndex	レコードの取得を開始するテーブルへの 1 ベースのインデックス。たとえば、このパラメーターを 100 に設定し、count パラメーターを 20 に設定すると、エンドポイントは 100 ～ 119 のレコードを返します。 注: 1 未満に設定された値は 1 と解釈されます。 データタイプ：文字列 デフォルト：1

表 : 21. 要求本文パラメーター (JSON)

名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

表 : 22. 要求ヘッダー

ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/scim+json。 デフォルト： application/json

表 : 23. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 24. ステータスコード

ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 attributes と excludedAttributes の両方のクエリパラメーターが要求で渡されていないことを確認してください。 count パラメーターが 500 を超えないようにしてください。 すべての filter パラメーターが有効であることを確認してください。
401	権限がありません。ユーザー資格情報が間違っているか、渡されていません。

応答本文のパラメーター (JSON)

名前	説明
itemsPerPage	返される結果で返されるレコードの数。 データタイプ：数値
リソース	グループレコードリスト。 データタイプ：オブジェクトのアレイ "Resources": [ { "company": {Object}, "displayName": "String", "externalId": "String", "id": "String", "meta": [Array] } ]
Resources.company	グループの会社または組織に関する詳細。 データタイプ：オブジェクト "company": { "display": "String", "$ref": "String", "value": "String" }
Resources.company.display	会社の名前 データタイプ：文字列
Resources.company.$ref	会社の参照 URI。 形式：<host>/Companies/<company sys_id>。例：http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 。 データタイプ：文字列
Resources.company.value	関連付けられた会社の sys_id。 データタイプ：文字列
Resources.displayName	HR チームなど、グループの分かりやすい名前。 データタイプ：文字列
Resources.externalId	グループをプロビジョニングするエンティティによってグループにアサインされた一意の識別子。 データタイプ：文字列
Resources.id	グループの sys_id。 データタイプ：文字列
Resources.meta	グループに関するメタデータ。 データタイプ：オブジェクト "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
Resources.meta.created	グループレコードが作成された日時。 データタイプ：文字列
Resources.meta.lastModified	グループレコードが最後に変更された日時。 データタイプ：文字列
Resources.meta.location	取得されるグループの URI。 データタイプ：文字列
Resources.meta.resourceType	SCIM グループのリソースタイプ。 データタイプ：文字列
Resources.members	グループに関連付けるユーザーおよびグループのリスト。 データタイプ：オブジェクトのアレイ "members": [ { "display": "String", "value": "String", "$ref": "String" } ]
Resources.members.display	関連付けられたグループメンバーの名前。 データタイプ：文字列
Resources.members.value	関連付けられたユーザーまたはグループレコードの sys_id。 データタイプ：文字列
Resources.members.$ref	関連付けられたグループメンバーの URI。 データタイプ：文字列
Resources.schemas	要求の処理に使用される SCIM グループスキーマの URI のリスト。 サポート済みグループスキーマ： urn:ietf:params:scim:schemas:core:2.0:Group - クロスドメイン ID 管理のためにインターネットエンジニアリングタスクフォースシステムで指定されたコアスキーマ：コアスキーマドキュメント (https://datatracker.ietf.org/doc/html/rfc7643#section-4.2) urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group - ServiceNow 拡張スキーマ。このスキーマには、基本 ServiceNow システムのグループ [sys_user_group] テーブルに存在している属性が含まれています。ただし、この属性はコアスキーマの一部ではありません。 urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group” - カスタム拡張スキーマ。このスキーマは、sys_scim_schema_extension テーブルの「Group」resourceType の一部です。スキーマがアクティブでない場合、スキーマ URN は応答で返されません。 データタイプ：文字列のアレイ
schemas	要求の処理に使用される SCIM リスト応答スキーマの URI のリスト。 データタイプ：アレイ
startIndex	エンドポイントがレコードの取得を開始したグループ [sys_user_group] テーブルの 1 ベースのインデックス。 データタイプ：数値
totalResults	要求に一致するレコードの合計数。 データタイプ：数値

複数のグループに対する cURL 要求

この例は、count パラメーターを使用して複数のグループ (この場合は 4 つ) を要求する方法を示しています。

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

応答：

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

excludedAttributes を使用した複数グループの cURL 要求

この例は、count パラメーターを使用して複数のグループ (この場合は 4 つ) を要求し、メタフィールドとメンバーフィールドを除外する方法を示しています。

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

応答：

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

クロスドメイン ID 管理システム (SCIM) プロトコルを使用して、ServiceNow インスタンス内のグループ [sys_user_group] テーブルから指定されたグループレコードを返します。

URL 形式

バージョニングされた URL：/api/now/{api_version}/scim/Groups/{group_id}

デフォルトの URL：/api/now/scim/Groups/{group_id}

注:

利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

サポートされている要求パラメーター

表 : 25. パスパラメーター

名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列
group_id	返されるグループレコードの sys_id。

表 : 26. クエリパラメーター

名前	説明
attributes	応答で返すカンマ区切りのフィールドのリストです。他のフィールドは返されません。 excludedAttributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：excludedAttributes が指定されていない限り、すべてのフィールドを返します。
excludedAttributes	応答で返されるレコードから除外するフィールドのカンマ区切りのリスト。他のすべてのフィールドが返されます。 attributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：どのフィールドも除外しません。

表 : 27. 要求本文パラメーター (JSON)

名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

表 : 28. 要求ヘッダー

ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/scim+json。 デフォルト： application/json

表 : 29. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 30. ステータスコード

ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 attributes と excludedAttributes の両方のクエリパラメーターが要求で渡されていないことを確認してください。 count パラメーターが 500 を超えないようにしてください。 すべての filter パラメーターが有効であることを確認してください。
404	見つかりません。要求されたアイテムが見つかりませんでした。

応答本文のパラメーター (JSON)

名前	説明
company	グループの会社または組織に関する詳細。 データタイプ：オブジェクト "company": { "display": "String", "$ref": "String", "value": "String" }
company.display	会社の名前 データタイプ：文字列
company.$ref	会社の参照 URI。 形式：<host>/Companies/<company sys_id>。例：http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 。 データタイプ：文字列
company.value	関連付けられた会社の sys_id。 データタイプ：文字列
displayName	HR チームなど、グループの分かりやすい名前。 データタイプ：文字列
externalId	グループをプロビジョニングするエンティティによってグループにアサインされた一意の識別子。 データタイプ：文字列
id	グループの sys_id。 データタイプ：文字列
meta	グループに関するメタデータ。 データタイプ：オブジェクト "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
meta.created	グループレコードが作成された日時。 データタイプ：文字列
meta.lastModified	グループレコードが最後に変更された日時。 データタイプ：文字列
meta.location	取得されるグループの URI。 データタイプ：文字列
meta.resourceType	SCIM グループのリソースタイプ。 データタイプ：文字列
members	グループに関連付けるユーザーおよびグループのリスト。 データタイプ：オブジェクトのアレイ "members": [ { "display": "String", "value": "String", "$ref": "String" } ]
members.display	関連付けられたグループメンバーの名前。 データタイプ：文字列
members.value	関連付けられたユーザーまたはグループレコードの sys_id。 データタイプ：文字列
members.$ref	関連付けられたグループメンバーの URI。 データタイプ：文字列
schemas	要求の処理に使用される SCIM グループスキーマの URI のリスト。 サポート済みグループスキーマ： urn:ietf:params:scim:schemas:core:2.0:Group - クロスドメイン ID 管理のためにインターネットエンジニアリングタスクフォースシステムで指定されたコアスキーマ：コアスキーマドキュメント (https://datatracker.ietf.org/doc/html/rfc7643#section-4.2) urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group - ServiceNow 拡張スキーマ。このスキーマには、基本 ServiceNow システムのグループ [sys_user_group] テーブルに存在している属性が含まれています。ただし、この属性はコアスキーマの一部ではありません。 urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group” - カスタム拡張スキーマ。このスキーマは、sys_scim_schema_extension テーブルの「Group」resourceType の一部です。スキーマがアクティブでない場合、スキーマ URN は応答で返されません。 データタイプ：文字列のアレイ

特定のグループに対する cURL 要求

この例は、特定のグループレコードを取得する方法を示しています。

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

応答：

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

クロスドメイン ID 管理システム (SCIM) プロトコルを使用して、ServiceNow インスタンスのグループ [sys_user_group] テーブル内のグループレコードの指定されたフィールドを追加、更新、および削除できます。

詳細については、RFC 7644 の「PATCH を使用した変更 (Modifying with PATCH)」セクションを参照してください。

URL 形式

バージョニングされた URL：/api/now/{api_version}/scim/Groups/{group_id}

デフォルトの URL：/api/now/scim/Groups/{group_id}

サポートされている要求パラメーター

表 : 31. パスパラメーター

名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列
group_id	更新するグループレコードの sys_id。 データタイプ：文字列 テーブル： Group [sys_user_group]

表 : 32. クエリパラメーター

名前	説明
attributes	応答で返すカンマ区切りのフィールドのリストです。他のフィールドは返されません。 excludedAttributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：excludedAttributes が指定されていない限り、すべてのフィールドを返します。
excludedAttributes	応答で返されるレコードから除外するフィールドのカンマ区切りのリスト。他のすべてのフィールドが返されます。 attributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：どのフィールドも除外しません。

表 : 33. 要求本文パラメーター (JSON)

名前	説明
Operations	必須です。指定されたグループレコードにパッチを適用する操作オブジェクトのリスト。 データタイプ：オブジェクトのアレイ "Operations": [ { "op": "String", "path": "String", "value": Any } ]
Operations.op	必須です。実行する操作。 有効な値： add：指定されたフィールドと値をグループレコードに追加します。 remove：指定されたフィールドから値を削除します。データタイプ「null」に置き換えられます。 replace：指定されたフィールドの値を置き換えます。 データタイプ：文字列
Operations.path	remove 操作の場合は必須、それ以外の場合はオプションです。変更するフィールドの名前/パス。 path パラメーターは、次のいずれかの形式にすることができます。 フィールドを直接使用 (displayName など) 複合アレイの場合は、フィルターのある特定の要素へのポインター (例：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" } } ] } データタイプ：文字列 デフォルト：フィールドをリソースと見なします。
Operations.value	Operations.path パラメーターで指定されたフィールドの値。このパラメーターの形式は、関連するフィールドのデータ タイプによって異なります。 たとえば、タイトルなどの単純な文字列を更新する場合、value フィールドは文字列として表されます。 "Operations": [ { "op": "add", "path": "displayName", "value": "HR Group" } ] 次のように、path パラメーターのない単純な文字列値を宣言することもできます。 "Operations": [ { "op": "add", "value": { "displayName": "HR Group" } } ] グループにメンバーを追加する方法は次のとおりです。 { "op": "add", "value": { "members": { "value": "62826bf03710200044e0bfc8bcbe5df1", } } } 更新されるフィールドがベーススキーマにない場合は、関連するスキーマの URN を指定するオブジェクトで名前と値のペアを囲む必要があります。 "value": { "<schema_urn>": { "<field_name>": "<new_value>" }, } 例： "value": { "urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group": { "groupNumber": "13454" }, } データタイプ：任意
Operations.value.type	更新するフィールドの名前。 データタイプ：文字列
Operations.value.value	フィールドを更新する値。 データタイプ：文字列
schemas	必須です。パッチ操作の SCIM スキーマ URI："urn:ietf:params:scim:api:messages:2.0:PatchOp” データタイプ：文字列

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

表 : 34. 要求ヘッダー

ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/scim+json。 デフォルト： application/json
Content-Type	要求本文のデータ形式。サポートされるタイプ：application/json または application/scim+json。 デフォルト： application/json

表 : 35. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 36. ステータスコード

ステータスコード	説明
200	成功。要求が正常に処理されました。
204	成功。コンテンツなし (SCIM グループパッチ API にのみ適用) :この 204 ステータスは、SCIM UI プロパティ [ コンテンツなしのグループパッチ API 応答を有効にする] のステータスに依存し、RFC: https://www.rfc-editor.org/rfc/rfc7644#page-35 に従って渡された属性パラメーターの対象となります。 デフォルトのプロパティ値:false クライアントが応答リソースを消費する予定がない場合は、[ Enable Group Patch API response with No Content] プロパティを使用して、追加の応答実行パフォーマンスの向上を得ることができます。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 次の無効な値を確認します。 要求本文が正しくありません。 必須フィールドが指定されていないか、空です。 無効なユーザーまたはグループ sys_id が指定されました。 読み取り専用または不変のフィールドの変更が試みられているかどうかを確認します。 attributes と excludedAttributes の両方のクエリパラメーターが要求で渡されていないこと、または要求が最大メンバー数を超えていないことを確認してください。
404	見つかりません。要求されたアイテムが見つかりませんでした。
409	グループは既に存在します。displayName パラメーターは一意である必要があります。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON)

名前	説明
company	グループの会社または組織に関する詳細。 データタイプ：オブジェクト "company": { "display": "String", "$ref": "String", "value": "String" }
company.display	会社の名前 データタイプ：文字列
company.$ref	会社の参照 URI。 形式：<host>/Companies/<company sys_id>。例：http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 。 データタイプ：文字列
company.value	関連付けられた会社の sys_id。 データタイプ：文字列
displayName	HR チームなど、グループの分かりやすい名前。 データタイプ：文字列
externalId	グループをプロビジョニングするエンティティによってグループにアサインされた一意の識別子。 データタイプ：文字列
errors	要求の処理中に発生した可能性のあるエラーを説明する応答。 データタイプ：オブジェクト "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" }
errors.detail	要求が失敗した理由に関する詳細なエラーメッセージ。 データタイプ：文字列
errors.scimType	SCIM エラーの詳細キーワード。 データタイプ：文字列
errors.schemas	エラー応答の処理に使用される SCIM スキーマの URI。 データタイプ：文字列のアレイ
errors.status	エラー応答の HTTP ステータスコード。 データタイプ：文字列
displayName	HR チームなど、グループの分かりやすい名前。 データタイプ：文字列
externalId	グループをプロビジョニングするエンティティによってグループにアサインされた一意の識別子。 データタイプ：文字列
id	グループの sys_id。 データタイプ：文字列
members	グループに関連付けるユーザーおよびグループのリスト。 データタイプ：オブジェクトのアレイ "members": [ { "display": "String", "value": "String", "$ref": "String" } ]
members.display	関連付けられたグループメンバーの名前。 データタイプ：文字列
members.value	関連付けられたユーザーまたはグループレコードの sys_id。 データタイプ：文字列
members.$ref	関連付けられたグループメンバーの URI。 データタイプ：文字列
meta	グループに関するメタデータ。 データタイプ：オブジェクト "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
meta.created	グループレコードが作成された日時。 データタイプ：文字列
meta.lastModified	グループレコードが最後に変更された日時。 データタイプ：文字列
meta.location	取得されるグループの URI。 データタイプ：文字列
meta.resourceType	SCIM グループのリソースタイプ。 データタイプ：文字列
schemas	要求の処理に使用される SCIM グループスキーマの URI のリスト。 サポート済みグループスキーマ： urn:ietf:params:scim:schemas:core:2.0:Group - クロスドメイン ID 管理のためにインターネットエンジニアリングタスクフォースシステムで指定されたコアスキーマ：コアスキーマドキュメント (https://datatracker.ietf.org/doc/html/rfc7643#section-4.2) urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group - ServiceNow 拡張スキーマ。このスキーマには、基本 ServiceNow システムのグループ [sys_user_group] テーブルに存在している属性が含まれています。ただし、この属性はコアスキーマの一部ではありません。 urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group” - カスタム拡張スキーマ。このスキーマは、sys_scim_schema_extension テーブルの「Group」resourceType の一部です。スキーマがアクティブでない場合、スキーマ URN は応答で返されません。 データタイプ：文字列のアレイ

cURL 要求

この例は、グループレコードに外部 ID を追加し、関連付けられたメンバー (ユーザー) の現在のリストを置き換える方法を示しています。

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

応答：

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

クロスドメイン ID 管理システム (SCIM) プロトコルを使用して、ServiceNow インスタンスのグループ [sys_user_group] テーブルにグループレコードを作成します。

グループの表示名、このグループを外部システムに相関付けるために使用する外部 ID を定義し、メンバー (ユーザー/グループ) をグループに追加できます。

注:

RFC7643 仕様に記載されている検索および一括変更機能は、このエンドポイントではサポートされていません。

URL 形式

バージョニングされた URL：/api/now/{api_version}/scim/Groups

デフォルトの URL：/api/now/scim/Groups

注:

利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

サポートされている要求パラメーター

表 : 37. パスパラメーター

名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列

表 : 38. クエリパラメーター

名前	説明
attributes	応答で返すカンマ区切りのフィールドのリストです。他のフィールドは返されません。 excludedAttributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：excludedAttributes が指定されていない限り、すべてのフィールドを返します。
excludedAttributes	応答で返されるレコードから除外するフィールドのカンマ区切りのリスト。他のすべてのフィールドが返されます。 attributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：どのフィールドも除外しません。

表 : 39. 要求本文パラメーター (JSON)

名前	説明
company	グループの会社または組織に関する詳細。 データタイプ：オブジェクト "company": { "display": "String", "$ref": "String", "value": "String" }
company.display	会社の名前 データタイプ：文字列
company.$ref	会社の参照 URI。 形式：<host>/Companies/<company sys_id>。例：http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 。 データタイプ：文字列
company.value	関連付けられた会社の sys_id。 データタイプ：文字列
displayName	必須です。HR チームなど、グループの分かりやすい名前。 データタイプ：文字列
externalId	グループをプロビジョニングするエンティティによってグループにアサインされた一意の識別子。 データタイプ：文字列
members	グループに関連付けるユーザーまたは他のグループのリスト。 データタイプ：オブジェクトのアレイ "members:" [ { "value": "String" } ] 最大サイズ：100 - システムプロパティ com.snc.interation.scim2.max.member.count を更新することで、この最大サイズを変更できます。
members.value	関連付けられたユーザーまたはグループレコードの sys_id。 データタイプ：文字列
schemas	必須です。 要求の処理に使用される SCIM グループスキーマの URI のリスト。 サポート済みグループスキーマ： urn:ietf:params:scim:schemas:core:2.0:Group - クロスドメイン ID 管理のためにインターネットエンジニアリングタスクフォースシステムで指定されたコアスキーマ：コアスキーマドキュメント (https://datatracker.ietf.org/doc/html/rfc7643#section-4.2) urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group - ServiceNow 拡張スキーマ。このスキーマには、基本 ServiceNow システムのグループ [sys_user_group] テーブルに存在している属性が含まれています。ただし、この属性はコアスキーマの一部ではありません。 urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group” - カスタム拡張スキーマ。このスキーマは、sys_scim_schema_extension テーブルの「Group」resourceType の一部です。スキーマがアクティブでない場合、スキーマ URN は応答で返されません。 データタイプ：文字列のアレイ

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

表 : 40. 要求ヘッダー

ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/scim+json。 デフォルト： application/json
Content-Type	要求本文のデータ形式。サポートされるタイプ：application/json または application/scim+json。 デフォルト： application/json

表 : 41. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 42. ステータスコード

ステータスコード	説明
201	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 次の無効な値を確認します。 要求本文が正しくありません。 必須フィールドが指定されていないか、空です。 無効なユーザーまたはグループ sys_id が指定されました。 読み取り専用または不変のフィールドの変更が試みられているかどうかを確認します。 attributes と excludedAttributes の両方のクエリパラメーターが要求で渡されていないこと、または要求が最大メンバー数を超えていないことを確認してください。
409	グループは既に存在します。displayName パラメーターは一意である必要があります。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON)

名前	説明
company	グループの会社または組織に関する詳細。 データタイプ：オブジェクト "company": { "display": "String", "$ref": "String", "value": "String" }
company.display	会社の名前 データタイプ：文字列
company.$ref	会社の参照 URI。 形式：<host>/Companies/<company sys_id>。例：http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 。 データタイプ：文字列
company.value	関連付けられた会社の sys_id。 データタイプ：文字列
displayName	HR チームなど、グループの分かりやすい名前。 データタイプ：文字列
externalId	グループをプロビジョニングするエンティティによってグループにアサインされた一意の識別子。 データタイプ：文字列
id	グループの sys_id。 データタイプ：文字列
meta	グループに関するメタデータ。 データタイプ：オブジェクト "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
meta.created	グループレコードが作成された日時。 データタイプ：文字列
meta.lastModified	グループレコードが最後に変更された日時。 データタイプ：文字列
meta.location	取得されるグループの URI。 データタイプ：文字列
meta.resourceType	SCIM グループのリソースタイプ。 データタイプ：文字列
members	グループに関連付けるユーザーおよびグループのリスト。 データタイプ：オブジェクトのアレイ "members": [ { "display": "String", "value": "String", "$ref": "String" } ]
members.display	関連付けられたグループメンバーの名前。 データタイプ：文字列
members.value	関連付けられたユーザーまたはグループレコードの sys_id。 データタイプ：文字列
members.$ref	関連付けられたグループメンバーの URI。 データタイプ：文字列
schemas	要求の処理に使用される SCIM グループスキーマの URI のリスト。 サポート済みグループスキーマ： urn:ietf:params:scim:schemas:core:2.0:Group - クロスドメイン ID 管理のためにインターネットエンジニアリングタスクフォースシステムで指定されたコアスキーマ：コアスキーマドキュメント (https://datatracker.ietf.org/doc/html/rfc7643#section-4.2) urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group - ServiceNow 拡張スキーマ。このスキーマには、基本 ServiceNow システムのグループ [sys_user_group] テーブルに存在している属性が含まれています。ただし、この属性はコアスキーマの一部ではありません。 urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group” - カスタム拡張スキーマ。このスキーマは、sys_scim_schema_extension テーブルの「Group」resourceType の一部です。スキーマがアクティブでない場合、スキーマ URN は応答で返されません。 データタイプ：文字列のアレイ

cURL 要求での新しいグループの POST とメンバーの追加

この例では、group51 を作成し、ユーザー Abel Tutor をメンバーとして追加しています。

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

応答：

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

クロスドメイン ID 管理システム (SCIM) プロトコルを使用して、ServiceNow インスタンスのグループ [sys_user_group] テーブルの指定されたグループレコードを更新します。

要求で省略されたフィールドは更新されません。フィールドを明示的にクリアするには、その値を単一値フィールドでは null に設定し、members などのアレイタイプのフィールドでは空のアレイに設定します。

URL 形式

バージョニングされた URL：/api/now/{api_version}/scim/Groups/{group_id}

デフォルトの URL：/api/now/scim/Groups/{group_id}

注:

利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

サポートされている要求パラメーター

表 : 43. パスパラメーター

名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列
group_id	更新するグループレコードの sys_id。 データタイプ：文字列 テーブル： Group [sys_user_group]

表 : 44. クエリパラメーター

名前	説明
attributes	応答で返すカンマ区切りのフィールドのリストです。他のフィールドは返されません。 excludedAttributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：excludedAttributes が指定されていない限り、すべてのフィールドを返します。
excludedAttributes	応答で返されるレコードから除外するフィールドのカンマ区切りのリスト。他のすべてのフィールドが返されます。 attributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：どのフィールドも除外しません。

表 : 45. 要求本文パラメーター (JSON)

名前	説明
company	グループの会社または組織に関する詳細。 データタイプ：オブジェクト "company": { "display": "String", "$ref": "String", "value": "String" }
company.display	会社の名前 データタイプ：文字列
company.$ref	会社の参照 URI。 形式：<host>/Companies/<company sys_id>。例：http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 。 データタイプ：文字列
company.value	関連付けられた会社の sys_id。 データタイプ：文字列
displayName	HR チームなど、グループの分かりやすい名前。 データタイプ：文字列
externalId	グループをプロビジョニングするエンティティによってグループにアサインされた一意の識別子。 データタイプ：文字列
members	現在のメンバーリストを置き換えるユーザーのリスト。 データタイプ：オブジェクトのアレイ "members:" [ { "value": "String" } ] 最大サイズ：100 - システムプロパティ com.snc.interation.scim2.max.member.count を更新することで、この最大サイズを変更できます。
members.value	関連付けられたユーザーまたはグループレコードの sys_id。 データタイプ：文字列
schemas	必須です。 要求の処理に使用される SCIM グループスキーマの URI のリスト。 サポート済みグループスキーマ： urn:ietf:params:scim:schemas:core:2.0:Group - クロスドメイン ID 管理のためにインターネットエンジニアリングタスクフォースシステムで指定されたコアスキーマ：コアスキーマドキュメント (https://datatracker.ietf.org/doc/html/rfc7643#section-4.2) urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group - ServiceNow 拡張スキーマ。このスキーマには、基本 ServiceNow システムのグループ [sys_user_group] テーブルに存在している属性が含まれています。ただし、この属性はコアスキーマの一部ではありません。 urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group” - カスタム拡張スキーマ。このスキーマは、sys_scim_schema_extension テーブルの「Group」resourceType の一部です。スキーマがアクティブでない場合、スキーマ URN は応答で返されません。 データタイプ：文字列のアレイ

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

表 : 46. 要求ヘッダー

ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/scim+json。 デフォルト： application/json
Content-Type	要求本文のデータ形式。サポートされるタイプ：application/json または application/scim+json。 デフォルト： application/json

表 : 47. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 48. ステータスコード

ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 次の無効な値を確認します。 要求本文が正しくありません。 必須フィールドが指定されていないか、空です。 無効なユーザーまたはグループ sys_id が指定されました。 読み取り専用または不変のフィールドの変更が試みられているかどうかを確認します。 attributes と excludedAttributes の両方のクエリパラメーターが要求で渡されていないこと、または要求が最大メンバー数を超えていないことを確認してください。
404	見つかりません。要求されたアイテムが見つかりませんでした。
409	グループは既に存在します。displayName パラメーターは一意である必要があります。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON)

名前	説明
company	グループの会社または組織に関する詳細。 データタイプ：オブジェクト "company": { "display": "String", "$ref": "String", "value": "String" }
company.display	会社の名前 データタイプ：文字列
company.$ref	会社の参照 URI。 形式：<host>/Companies/<company sys_id>。例：http://instance-servicenow.com/api/now/scim/Companies/81fd65ecac1d55eb42a426568fc87a63 。 データタイプ：文字列
company.value	関連付けられた会社の sys_id。 データタイプ：文字列
displayName	HR チームなど、グループの分かりやすい名前。 データタイプ：文字列
errors	要求の処理中に発生した可能性のあるエラーを説明する応答。 データタイプ：オブジェクト "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" }
errors.detail	要求が失敗した理由に関する詳細なエラーメッセージ。 データタイプ：文字列
errors.scimType	SCIM エラーの詳細キーワード。 データタイプ：文字列
errors.schemas	エラー応答の処理に使用される SCIM スキーマの URI。 データタイプ：文字列のアレイ
errors.status	エラー応答の HTTP ステータスコード。 データタイプ：文字列
externalId	グループをプロビジョニングするエンティティによってグループにアサインされた一意の識別子。 データタイプ：文字列
id	グループの sys_id。 データタイプ：文字列
members	グループに関連付けるユーザーおよびグループのリスト。 データタイプ：オブジェクトのアレイ "members": [ { "display": "String", "value": "String", "$ref": "String" } ]
members.display	関連付けられたグループメンバーの名前。 データタイプ：文字列
members.value	関連付けられたユーザーまたはグループレコードの sys_id。 データタイプ：文字列
members.$ref	関連付けられたグループメンバーの URI。 データタイプ：文字列
meta	グループに関するメタデータ。 データタイプ：オブジェクト "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
meta.created	グループレコードが作成された日時。 データタイプ：文字列
meta.lastModified	グループレコードが最後に変更された日時。 データタイプ：文字列
meta.location	取得されるグループの URI。 データタイプ：文字列
meta.resourceType	SCIM グループのリソースタイプ。 データタイプ：文字列
schemas	要求の処理に使用される SCIM グループスキーマの URI のリスト。 サポート済みグループスキーマ： urn:ietf:params:scim:schemas:core:2.0:Group - クロスドメイン ID 管理のためにインターネットエンジニアリングタスクフォースシステムで指定されたコアスキーマ：コアスキーマドキュメント (https://datatracker.ietf.org/doc/html/rfc7643#section-4.2) urn:ietf:params:scim:schemas:extension:servicenow:2.0:Group - ServiceNow 拡張スキーマ。このスキーマには、基本 ServiceNow システムのグループ [sys_user_group] テーブルに存在している属性が含まれています。ただし、この属性はコアスキーマの一部ではありません。 urn:ietf:params:scim:schemas:extension:servicenow:custom:2.0:Group” - カスタム拡張スキーマ。このスキーマは、sys_scim_schema_extension テーブルの「Group」resourceType の一部です。スキーマがアクティブでない場合、スキーマ URN は応答で返されません。 データタイプ：文字列のアレイ

PUT を使用してグループメンバーを更新する cURL 要求

次の例は、グループに関連付けられたメンバーを Abel Tutor ではなく Abraham Lincoln に変更し、グループの名前を HR Team に変更しています。

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

応答：

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

クロスドメイン ID 管理システム (SCIM) プロトコルを使用して、ServiceNow インスタンスのユーザー [sys_user] テーブルから指定されたユーザーレコードを削除します。

URL 形式

バージョニングされた URL：/api/now/{api_version}/scim/Users/{user_id}

デフォルトの URL：/api/now/scim/Users/{user_id}

注:

利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

サポートされている要求パラメーター

表 : 49. パスパラメーター

名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列
user_id	削除するユーザーレコードの sys_id。 データタイプ：文字列 テーブル:ユーザー [sys_user]

表 : 50. クエリパラメーター

名前	説明
なし

表 : 51. 要求本文パラメーター (JSON)

名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

表 : 52. 要求ヘッダー

ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/scim+json。 デフォルト： application/json

表 : 53. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 54. ステータスコード

ステータスコード	説明
204	コンテンツがありません。要求が正常に処理されました。
404	見つかりません。要求されたアイテムが見つかりませんでした。

応答本文のパラメーター (JSON)

名前	説明
errors	要求の処理中に発生した可能性のあるエラーを説明する応答。 データタイプ：オブジェクト "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" }
errors.detail	要求が失敗した理由に関する詳細なエラーメッセージ。 データタイプ：文字列
errors.scimType	SCIM エラーの詳細キーワード。 データタイプ：文字列
errors.schemas	エラー応答の処理に使用される SCIM スキーマの URI。 データタイプ：文字列のアレイ
errors.status	エラー応答の HTTP ステータスコード。 データタイプ：文字列

cURL 要求

この例は、ユーザー [sys_user] テーブルからユーザーレコードを削除する方法を示しています。

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

SCIM - GET /scim/Users

クロスドメイン ID 管理システム (SCIM) プロトコルを使用して、ServiceNow インスタンス内のユーザー [sys_user] テーブルから 1 つ以上のユーザーレコードを返します。

注:

一致を返さないクエリは、totalResults が 0 に設定された状態で成功 (HTTP ステータスコード 200) を返します。

URL 形式

バージョニングされた URL：/api/now/{api_version}/scim/Users

デフォルトの URL：/api/now/scim/Users

注:

利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

サポートされている要求パラメーター

表 : 55. パスパラメーター

名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列

表 : 56. クエリパラメーター

名前	説明
attributes	応答で返すカンマ区切りのフィールドのリストです。他のフィールドは返されません。 excludedAttributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：excludedAttributes が指定されていない限り、すべてのフィールドを返します。
count	返されるレコードの数。負の値はゼロと解釈されます。 データタイプ：数値 最大：500 - これより大きい値を指定すると、不正な要求エラーが発生します。 デフォルト：10
excludedAttributes	応答で返されるレコードから除外するフィールドのカンマ区切りのリスト。他のすべてのフィールドが返されます。 attributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：どのフィールドも除外しません。
filter	返される結果に適用するフィルター式。フィールドフィルターは、<field_name> <operator> <"value"> として表されます。有効な演算子のリストについては、RFC7644 を参照してください。 注: NOT 演算子はサポートされていません。 たとえば、名前が「Jo」で始まるすべてのユーザーをフィルタリングするには、「userName SW "jo"」と入力します (大文字と小文字を区別しません)。 複数のフィールドフィルターを指定するには、AND オペランドを使用してフィルターを連結します。たとえば、名前が「Jo」で始まり、姓に「smi」が含まれているすべてのユーザーをフィルタリングするには、「userName SW "john" AND name.familyName CO "smi"」と入力します。ネストされた属性を指定するには、ドット連結を使用します。 フィルターで使用できるのは次の SCIM ユーザーフィールドのみです。前述のとおり、一部は固定形式のみをサポートしています。 active addresses - 次のような固定形式のみ： [type eq "home" and streetAddress eq "xxxx"] [type eq "home" and locality eq "xxxx"] [type eq "home" and region eq "xxxx"] [type eq "home" and postalCode eq "xxxx"] [type eq "home" and country eq "xxxx"] displayName emails - [type eq "work" and value eq "emailValue"] などの固定形式のみ externalId - EQ 演算子のみがサポートされています。 id meta.created meta.lastModified name.familyName name.givenName name.middleName preferredLanguage phoneNumbers - 次のような固定形式のみ： [type eq “work” and value eq “xxxx”] [type eq “mobile” and value eq “xxxx”] [type eq “home” and value eq “xxxx”] timezone title 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 データタイプ：文字列 デフォルト：フィルタリングなし
sortBy	sortOrder パラメーターで指定する必要があります。返される結果をソートするフィールド。ソートでは大文字と小文字が区別されません。 sortBy パラメーターのフィルタリングに使用できるパラメーターのみを使用できます。ただし、externalId は、例外であり、許可されません。 また、次のドット連結パラメーターのみがサポートされています。 addressess - 次の値のみが許可されています。 addresses.streetAddress - 自宅の番地にマップします。 addresses.home.streetAddress addresses.locality - ローカルに自宅にマップします。 addresses.home.locality addresses.region - 自宅のリージョンにマップします。 addresses.home.region addresses.postalCode - 自宅の郵便番号にマップします。 addresses.home.postalCode addresses.country - 自国にマップします。 addresses.home.country emails - 次の値のみが許可されています。 emails.value - メールタイプの仕事にマップします。 emails.work.value phoneNumbers - 次の値のみが許可されています。 phoneNumbers.value - 電話番号タイプの仕事にマップします。 phoneNumbers.home.value phoneNumbers.mobile.value phoneNumbers.work.value null の値の場合： 昇順でソート - Null 値は一番上にソートされます。 降順でソート - Null 値は一番下にソートされます。 データタイプ：文字列 デフォルト：ソートは実行されません
sortOrder	sortBy パラメーターで指定する必要があります。sortBy パラメーターが返される結果に適用される順序。 有効な値： 昇順 降順 データタイプ：文字列 デフォルト：昇順
startIndex	レコードの取得を開始するユーザー [sys_user] テーブルへの 1 ベースのインデックス。たとえば、このパラメーターを 100 に設定し、count パラメーターを 20 に設定すると、エンドポイントは 100 ～ 119 のレコードを返します。 注: 1 未満に設定された値は 1 と解釈されます。 id パスパラメーターでは無効です。 データタイプ：文字列 デフォルト：1

表 : 57. 要求本文パラメーター (XML または JSON)

名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

表 : 58. 要求ヘッダー

ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/scim+json。 デフォルト： application/json

表 : 59. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 60. ステータスコード

ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 attributes と excludedAttributes の両方のクエリパラメーターが要求で渡されていないことを確認してください。 count パラメーターが 500 を超えないようにしてください。 すべての filter パラメーターが有効であることを確認してください。

応答本文のパラメーター (JSON)

名前	説明
itemsPerPage	返される結果で返されるレコードの数。 データタイプ：数値
リソース	ユーザーレコードリスト。 データタイプ：オブジェクトのアレイ "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	関連するユーザーが ServiceNow インスタンス内でアクティブかどうかを示すフラグ。 可能な値： true：ユーザーはアクティブです。 false：ユーザーは非アクティブです。 データタイプ：ブール
Resources.adresses	ユーザーの現在のメールアドレスの詳細。 データタイプ：オブジェクト "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" }
Resources.addresses.country	国名。 データタイプ：文字列
Resources.addresses.locality	市区町村名。 データタイプ：文字列
Resources.addresses.postalCode	郵便番号。 データタイプ：文字列
Resources.addresses.region	都道府県。 データタイプ：文字列
Resources.addresses.streetAddress	完全な所在地住所。これには、家屋番号、番地、私書箱、および複数行の拡張された所在地住所情報を含めることができます。 データタイプ：文字列
Resources.addresses.type	住所のタイプ。現在は home のみをサポートしています。 データタイプ：文字列
Resources.displayName	ユーザーの表示名。この値は、 name フィールドを連結することによって自動的に生成されます。 データタイプ：文字列
Resources.emails	ユーザーに関連付けられているメールアカウントのリスト。 データタイプ：オブジェクトのアレイ "emails:" [ { "type": "String", "value": "String" } ]
Resources.emails.type	ユーザーのメールタイプ。現在、「work」のタイプのみがサポートされています。 データタイプ：文字列
Resources.emails.value	ユーザーのメールアドレス。これは関連付けられたユーザーの一意のキーです。 データタイプ：文字列
Resources.externalId	ユーザーをプロビジョニングするエンティティによってユーザーにアサインされた一意の識別子。 データタイプ：文字列
Resources.groups	直接メンバーシップ、ネストされたグループ、または動的な計算を介してユーザーが属しているグループのリスト。 データタイプ：オブジェクトのアレイ "groups": [ { "display": "String", "type": "String", "value": "String", "$ref": "String" } ]
Resources.groups.display	関連付けられたグループの名前。 データタイプ：文字列
Resources.groups.type	直接または間接など、グループの関連付けのタイプ。 データタイプ：文字列
Resources.groups.value	関連付けられたグループレコードの sys_id。 データタイプ：文字列
Resources.groups.ref	関連付けられたグループの URI。 データタイプ：文字列
Resources.id	関連付けられたユーザーレコードの sys_id。 データタイプ：文字列
Resources.meta	ユーザーに関するメタデータ。 データタイプ：オブジェクト "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
Resources.meta.created	ユーザーレコードが作成された日時。 データタイプ：文字列
Resources.meta.lastModified	ユーザーレコードが最後に変更された日時。 データタイプ：文字列
Resources.meta.location	取得されるユーザーの URI。 データタイプ：文字列
Resources.meta.resourceType	SCIM ユーザーのリソースタイプ。 データタイプ：文字列
Resources.name	ユーザーの名前情報。 データタイプ：オブジェクト "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" }
Resources.name.familyName	ユーザーの姓。 データタイプ：文字列
Resources.name.givenName	ユーザーの名。 データタイプ：文字列
Resources.name.honorificPrefix	ユーザーの敬称または役職 (Dr.、Bishop、Baron など)。 データタイプ：文字列
Resources.name.middle	ユーザーのミドルネーム。 データタイプ：文字列
Resources.phoneNumbers	ユーザーに関連付けられた電話番号のリスト。 データタイプ：オブジェクトのアレイ "phoneNumbers": [ { "type": "String", "value": "String" } ]
Resources.phoneNumbers.type	電話番号のタイプ。 可能な値： ホーム mobile work データタイプ：文字列
Resources.phoneNumbers.value	ユーザーの電話番号。 データタイプ：文字列
Resources.preferredLanguage	ユーザーの優先される話し/書き言葉。 データタイプ：文字列
Resources.schemas	要求の処理に使用される SCIM ユーザースキーマの URI のリスト。 データタイプ：文字列のアレイ
Resources.timezone	ユーザーのタイムゾーン。 データタイプ：文字列
Resources.title	ユーザーの役職 (CEO や社長など)。 データタイプ：文字列
Resources.userName	関連付けられたユーザーの一意のユーザー名。 データタイプ：文字列
Resources.userType	ユーザータイプ。この値は、組織とユーザーの関係を識別するために使用されます。 これは任意の値にできますが、一般的な値には次のようなものがあります。 契約社員 従業員 インターン 一時 外部 不明 データタイプ：文字列
schemas	要求の処理に使用される SCIM ListResponse スキーマの URI のリスト。 データタイプ：文字列のアレイ
startIndex	レコードが返されたユーザー [sys_user] テーブルの 1 ベースのインデックス。 データタイプ：文字列
totalResults	要求に一致するレコードの合計数。 データタイプ：数値

返される拡張パラメーター

名前	説明
company	ユーザーの関連する会社に関する詳細。 データタイプ：オブジェクト "company": { "display": "String", "value": "String", "$ref": "String" }
company.display	会社の名前 データタイプ：文字列
company.value	会社レコードの sys_id。 データタイプ：文字列
company.$ref	会社の参照 URI。 データタイプ：文字列
costCenter	ユーザーの関連するコストセンターに関する詳細。 データタイプ：オブジェクト "costCenter": { "display": "String", "value": "String", "$ref": "String" }
costCenter.display	コストセンターの名前 データタイプ：文字列
costCenter.value	コストセンターレコードの sys_id。 データタイプ：文字列
costCenter.$ref	コストセンターの参照 URI。 データタイプ：文字列
department	ユーザーの関連する部門に関する詳細。 データタイプ：オブジェクト "department": { "display": "String", "value": "String", "$ref": "String" }
department.display	部門の名前。 データタイプ：文字列
department.value	部門レコードの sys_id。 データタイプ：文字列
department.$ref	部門の参照 URI。 データタイプ：文字列
employeeNumber	数値または英数字の従業員番号。 データタイプ：文字列
gender	ユーザーの性別 (男性、女性など)。 データタイプ：文字列
location	ユーザーの関連する場所に関する詳細。 データタイプ：オブジェクト "location": { "display": "String", "value": "String", "$ref": "String" }
location.display	場所の名前。 データタイプ：文字列
location.value	場所レコードの sys_id。 データタイプ：文字列
location.$ref	場所の参照 URI。 データタイプ：文字列
manager	ユーザーの関連するマネージャーに関する詳細。 データタイプ：オブジェクト "manager": { "display": "String", "value": "String", "$ref": "String" }
manager.display	マネージャーの名前。 データタイプ：文字列
manager.value	マネージャーレコードの sys_id。 データタイプ：文字列
manager.$ref	マネージャーの参照 URI。 データタイプ：文字列

属性を使用した cURL 要求

次の例は、6 番目のレコードから始まり、表示名のみを返す 2 人のユーザーを取得する方法を示しています。

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

応答：

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

次の例は、filter パラメーターを使用して、名が「a」で始まる最初の 2 つのユーザーレコードを返す方法を示しています。

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

応答：

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

クロスドメイン ID 管理システム (SCIM) プロトコルを使用して、ServiceNow インスタンス内のユーザー [sys_user] テーブルから指定されたユーザーレコードを返します。

URL 形式

バージョニングされた URL：/api/now/{api_version}/scim/Users/{user_id}

デフォルトの URL：/api/now/scim/Users/{user_id}

注:

利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

サポートされている要求パラメーター

表 : 61. パスパラメーター

名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列
user_id	返されるユーザーレコードの sys_id。 データタイプ：文字列 テーブル:ユーザー [sys_user]

表 : 62. クエリパラメーター

名前	説明
attributes	応答で返すカンマ区切りのフィールドのリストです。他のフィールドは返されません。 excludedAttributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：excludedAttributes が指定されていない限り、すべてのフィールドを返します。
excludedAttributes	応答で返されるレコードから除外するフィールドのカンマ区切りのリスト。他のすべてのフィールドが返されます。 attributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：どのフィールドも除外しません。

表 : 63. 要求本文パラメーター (JSON)

名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

表 : 64. 要求ヘッダー

ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/scim+json。 デフォルト： application/json

表 : 65. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 66. ステータスコード

ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 attributes と excludedAttributes の両方のクエリパラメーターが要求で渡されていないことを確認してください。 count パラメーターが 500 を超えないようにしてください。 すべての filter パラメーターが有効であることを確認してください。
404	見つかりません。要求されたアイテムが見つかりませんでした。

応答本文のパラメーター (JSON)

名前	説明
active	関連するユーザーが ServiceNow インスタンス内でアクティブかどうかを示すフラグ。 可能な値： true：ユーザーはアクティブです。 false：ユーザーは非アクティブです。 データタイプ：ブール
住所	ユーザーの現在のメールアドレスの詳細。 データタイプ：オブジェクト "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" }
addresses.country	国名。 データタイプ：文字列
addresses.locality	市区町村名。 データタイプ：文字列
addresses.postalCode	郵便番号。 データタイプ：文字列
addresses.region	都道府県。 データタイプ：文字列
addresses.streetAddress	完全な所在地住所。これには、家屋番号、番地、私書箱、および複数行の拡張された所在地住所情報を含めることができます。 データタイプ：文字列
addresses.type	住所のタイプ。現在は home のみをサポートしています。 データタイプ：文字列
displayName	ユーザーの表示名。この値は、 name フィールドを連結することによって自動的に生成されます。 データタイプ：文字列
メール	ユーザーに関連付けられているメールアカウントのリスト。 データタイプ：オブジェクトのアレイ "emails:" [ { "type": "String", "value": "String" } ]
emails.type	ユーザーのメールタイプ。現在、「work」のタイプのみがサポートされています。 データタイプ：文字列
emails.value	ユーザーのメールアドレス。これは関連付けられたユーザーの一意のキーです。 データタイプ：文字列
externalId	ユーザーをプロビジョニングするエンティティによってユーザーにアサインされた一意の識別子。 データタイプ：文字列
groups	直接メンバーシップ、ネストされたグループ、または動的な計算を介してユーザーが属しているグループのリスト。 データタイプ：オブジェクトのアレイ "groups": [ { "display": "String", "type": "String", "value": "String", "$ref": "String" } ]
groups.display	関連付けられたグループの名前。 データタイプ：文字列
groups.type	直接または間接など、グループの関連付けのタイプ。 データタイプ：文字列
groups.value	関連付けられたグループレコードの sys_id。 データタイプ：文字列
groups.$ref	関連付けられたグループの URI。 データタイプ：文字列
id	関連付けられたユーザーレコードの sys_id。 データタイプ：文字列
meta	ユーザーに関するメタデータ。 データタイプ：オブジェクト "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
meta.created	ユーザーレコードが作成された日時。 データタイプ：文字列
meta.lastModified	ユーザーレコードが最後に変更された日時。 データタイプ：文字列
meta.location	取得されるユーザーの URI。 データタイプ：文字列
meta.resourceType	SCIM ユーザーのリソースタイプ。 データタイプ：文字列
name	ユーザーの名前情報。 データタイプ：オブジェクト "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" }
name.familyName	ユーザーの姓。 データタイプ：文字列
name.givenName	ユーザーの名。 データタイプ：文字列
name.honorificPrefix	ユーザーの敬称または役職 (Dr.、Bishop、Baron など)。 データタイプ：文字列
name.middle	ユーザーのミドルネーム。 データタイプ：文字列
phoneNumbers	ユーザーに関連付けられた電話番号のリスト。 データタイプ：オブジェクトのアレイ "phoneNumbers": [ { "type": "String", "value": "String" } ]
phoneNumbers.type	電話番号のタイプ。 可能な値： ホーム mobile work データタイプ：文字列
phoneNumbers.value	ユーザーの電話番号。 データタイプ：文字列
preferredLanguage	ユーザーの優先される話し/書き言葉。 データタイプ：文字列
schemas	要求の処理に使用される SCIM ユーザースキーマの URI のリスト。 データタイプ：文字列のアレイ
timezone	ユーザーのタイムゾーン。 データタイプ：文字列
title	ユーザーの役職 (CEO や社長など)。 データタイプ：文字列
userName	関連付けられたユーザーの一意のユーザー名。 データタイプ：文字列
userType	ユーザータイプ。この値は、組織とユーザーの関係を識別するために使用されます。 これは任意の値にできますが、一般的な値には次のようなものがあります。 契約社員 従業員 インターン 一時 外部 不明 データタイプ：文字列

返される拡張パラメーター

名前	説明
company	ユーザーの関連する会社に関する詳細。 データタイプ：オブジェクト "company": { "display": "String", "value": "String", "$ref": "String" }
company.display	会社の名前 データタイプ：文字列
company.value	会社レコードの sys_id。 データタイプ：文字列
company.$ref	会社の参照 URI。 データタイプ：文字列
costCenter	ユーザーの関連するコストセンターに関する詳細。 データタイプ：オブジェクト "costCenter": { "display": "String", "value": "String", "$ref": "String" }
costCenter.display	コストセンターの名前 データタイプ：文字列
costCenter.value	コストセンターレコードの sys_id。 データタイプ：文字列
costCenter.$ref	コストセンターの参照 URI。 データタイプ：文字列
department	ユーザーの関連する部門に関する詳細。 データタイプ：オブジェクト "department": { "display": "String", "value": "String", "$ref": "String" }
department.display	部門の名前。 データタイプ：文字列
department.value	部門レコードの sys_id。 データタイプ：文字列
department.$ref	部門の参照 URI。 データタイプ：文字列
employeeNumber	数値または英数字の従業員番号。 データタイプ：文字列
gender	ユーザーの性別 (男性、女性など)。 データタイプ：文字列
location	ユーザーの関連する場所に関する詳細。 データタイプ：オブジェクト "location": { "display": "String", "value": "String", "$ref": "String" }
location.display	場所の名前。 データタイプ：文字列
location.value	場所レコードの sys_id。 データタイプ：文字列
location.$ref	場所の参照 URI。 データタイプ：文字列
manager	ユーザーの関連するマネージャーに関する詳細。 データタイプ：オブジェクト "manager": { "display": "String", "value": "String", "$ref": "String" }
manager.display	マネージャーの名前。 データタイプ：文字列
manager.value	マネージャーレコードの sys_id。 データタイプ：文字列
manager.$ref	マネージャーの参照 URI。 データタイプ：文字列

ユーザー sys_id を使用した cURL 要求

次の例は、sys_id を渡して特定のユーザーレコードを取得する方法を示しています。

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

応答：

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

クロスドメイン ID 管理システム (SCIM) プロトコルを使用して、ServiceNow インスタンスのユーザー [sys_user] テーブル内のユーザーレコードの指定されたフィールドを追加、置き換え、および削除できます。

URL 形式

バージョニングされた URL：/api/now/{api_version}/scim/Users/{user_id}

デフォルトの URL：/api/now/scim/Users/{user_id}

注:

利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

サポートされている要求パラメーター

表 : 67. パスパラメーター

名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列
user_id	変更するユーザーレコードの sys_id。 データタイプ：文字列 テーブル:ユーザー [sys_user]

表 : 68. クエリパラメーター

名前	説明
attributes	応答で返すカンマ区切りのフィールドのリストです。他のフィールドは返されません。 excludedAttributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：excludedAttributes が指定されていない限り、すべてのフィールドを返します。
excludedAttributes	応答で返されるレコードから除外するフィールドのカンマ区切りのリスト。他のすべてのフィールドが返されます。 attributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：どのフィールドも除外しません。

表 : 69. 要求本文パラメーター (JSON)

名前	説明
Operations	必須です。指定されたユーザーレコードにパッチを適用する操作オブジェクトのリスト。 データタイプ：アレイ "Operations": [ { "op": "String", "path": "String", "value": Any } ]
Operations.op	必須です。実行する操作。 有効な値： add：指定されたフィールドと値をユーザーレコードに追加します。 remove：指定されたフィールドから値を削除します。 replace：指定されたフィールドの値を置き換えます。 データタイプ：文字列
Operations.path	remove 操作の場合は必須です。変更するフィールドの名前/パス。 path パラメーターは、次のいずれかの形式にすることができます。 直接フィールド (title など) ネストされたフィールド (name.givenName など) 複合アレイの場合は、フィルターのある特定の要素をポイントできます (例：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]" } ] } データタイプ：文字列 デフォルト：フィールドをユーザーリソースと見なします。
Operations.value	Operations.path パラメーターで指定されたフィールドの値。このパラメーターの形式は、関連するフィールドのデータ タイプによって異なります。 たとえば、タイトルなどの単純な文字列を更新する場合、value フィールドは文字列として表されます。 "Operations": [ { "op": "add", "path": "title", "value": "xyz" } ] 次のように、value または path パラメーターを使用せずに単純な文字列値を宣言することもできます。 "Operations": [ { "op": "add", "title": "xyz" } ] ただし、ユーザーレコードに追加する追加フィールドとその関連値を定義するオブジェクトを含むアレイである電話番号を更新する場合、value フィールドはオブジェクトのアレイとして表されます。 "Operations": [ { "op": "add", "path": "phoneNumbers", "value": [ { "type": "work", "value": "9876543210" }, { "type": "home", "value": "9876783216" } ] } ] 属性ノードを指定する場合、エントリには次のようにネストを含めることができます。 { "op": "replace", "value": { "name": { "familyName": "Jones", "givenName": "Jennifer" } } } または、Operations.path でネストを指定することもできます。 { "op": "replace", "path": "name.givenName", "value": "Jennifer" } 更新されるフィールドがベーススキーマにない場合は、関連するスキーマの URN を指定するオブジェクトで名前と値のペアを囲む必要があります。 "value": { "<schema_urn>": { "<field_name>": "<new_value>" }, } 例： "value": { "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User": { "employeeNumber": "13454" }, } データタイプ：任意
Operations.value.type	更新するフィールドの名前。 データタイプ：文字列
Operations.value.value	フィールドを更新する値。 データタイプ：文字列
schemas	必須です。パッチ操作の SCIM スキーマ URI urn:ietf:params:scim:api:messages:2.0:PatchOp。 データタイプ：文字列

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

表 : 70. 要求ヘッダー

ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/scim+json。 デフォルト： application/json
Content-Type	要求本文のデータ形式。サポートされるタイプ：application/json または application/scim+json。 デフォルト： application/json

表 : 71. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 72. ステータスコード

ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 次の無効な値を確認します。 要求本文が正しくありません。 必須フィールドが指定されていないか、空です。 無効なユーザーまたはグループ sys_id が指定されました。 読み取り専用または不変のフィールドの変更が試みられているかどうかを確認します。 attributes と excludedAttributes の両方のクエリパラメーターが要求で渡されていないこと、または要求が最大メンバー数を超えていないことを確認してください。
404	見つかりません。要求されたアイテムが見つかりませんでした。
409	ユーザーが既に存在していますuserName パラメーターは一意である必要があります。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON)

名前	説明
active	関連するユーザーが ServiceNow インスタンス内でアクティブかどうかを示すフラグ。 可能な値： true：ユーザーはアクティブです。 false：ユーザーは非アクティブです。 データタイプ：ブール
住所	ユーザーの現在のメールアドレスの詳細。 データタイプ：オブジェクト "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" }
addresses.country	国名。 データタイプ：文字列
addresses.locality	市区町村名。 データタイプ：文字列
addresses.postalCode	郵便番号。 データタイプ：文字列
addresses.region	都道府県。 データタイプ：文字列
addresses.streetAddress	完全な所在地住所。これには、家屋番号、番地、私書箱、および複数行の拡張された所在地住所情報を含めることができます。 データタイプ：文字列
addresses.type	住所のタイプ。現在は home のみをサポートしています。 データタイプ：文字列
displayName	ユーザーの表示名。この値は、 name フィールドを連結することによって自動的に生成されます。 データタイプ：文字列
メール	ユーザーに関連付けられているメールアカウントのリスト。 データタイプ：オブジェクトのアレイ "emails:" [ { "type": "String", "value": "String" } ]
emails.type	ユーザーのメールタイプ。現在、「work」のタイプのみがサポートされています。 データタイプ：文字列
emails.value	ユーザーのメールアドレス。これは関連付けられたユーザーの一意のキーです。 データタイプ：文字列
errors	要求の処理中に発生した可能性のあるエラーを説明する応答。 データタイプ：オブジェクト "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" }
errors.detail	要求が失敗した理由に関する詳細なエラーメッセージ。 データタイプ：文字列
errors.scimType	SCIM エラーの詳細キーワード。 データタイプ：文字列
errors.schemas	エラー応答の処理に使用される SCIM スキーマの URI。 データタイプ：文字列のアレイ
errors.status	エラー応答の HTTP ステータスコード。 データタイプ：文字列
externalId	ユーザーをプロビジョニングするエンティティによってユーザーにアサインされた一意の識別子。 データタイプ：文字列
groups	直接メンバーシップ、ネストされたグループ、または動的な計算を介してユーザーが属しているグループのリスト。 データタイプ：オブジェクトのアレイ "groups": [ { "display": "String", "type": "String", "value": "String", "$ref": "String" } ]
groups.display	関連付けられたグループの名前。 データタイプ：文字列
groups.type	直接または間接など、グループの関連付けのタイプ。 データタイプ：文字列
groups.value	関連付けられたグループレコードの sys_id。 データタイプ：文字列
groups.$ref	関連付けられたグループの URI。 データタイプ：文字列
id	関連付けられたユーザーレコードの sys_id。 データタイプ：文字列
meta	ユーザーに関するメタデータ。 データタイプ：オブジェクト "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
meta.created	ユーザーレコードが作成された日時。 データタイプ：文字列
meta.lastModified	ユーザーレコードが最後に変更された日時。 データタイプ：文字列
meta.location	取得されるユーザーの URI。 データタイプ：文字列
meta.resourceType	SCIM ユーザーのリソースタイプ。 データタイプ：文字列
name	ユーザーの名前情報。 データタイプ：オブジェクト "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" }
name.familyName	ユーザーの姓。 データタイプ：文字列
name.givenName	ユーザーの名。 データタイプ：文字列
name.honorificPrefix	ユーザーの敬称または役職 (Dr.、Bishop、Baron など)。 データタイプ：文字列
name.middle	ユーザーのミドルネーム。 データタイプ：文字列
phoneNumbers	ユーザーに関連付けられた電話番号のリスト。 データタイプ：オブジェクトのアレイ "phoneNumbers": [ { "type": "String", "value": "String" } ]
phoneNumbers.type	電話番号のタイプ。 可能な値： ホーム mobile work データタイプ：文字列
phoneNumbers.value	ユーザーの電話番号。 データタイプ：文字列
preferredLanguage	ユーザーの優先される話し/書き言葉。 データタイプ：文字列
schemas	要求の処理に使用される SCIM ユーザースキーマの URI のリスト。 データタイプ：文字列のアレイ
timezone	ユーザーのタイムゾーン。 データタイプ：文字列
title	ユーザーの役職 (CEO や社長など)。 データタイプ：文字列
userName	関連付けられたユーザーの一意のユーザー名。 データタイプ：文字列
userType	ユーザータイプ。この値は、組織とユーザーの関係を識別するために使用されます。 これは任意の値にできますが、一般的な値には次のようなものがあります。 契約社員 従業員 インターン 一時 外部 不明 データタイプ：文字列

返される拡張パラメーター

名前	説明
company	ユーザーの関連する会社に関する詳細。 データタイプ：オブジェクト "company": { "display": "String", "value": "String", "$ref": "String" }
company.display	会社の名前 データタイプ：文字列
company.value	会社レコードの sys_id。 データタイプ：文字列
company.$ref	会社の参照 URI。 データタイプ：文字列
costCenter	ユーザーの関連するコストセンターに関する詳細。 データタイプ：オブジェクト "costCenter": { "display": "String", "value": "String", "$ref": "String" }
costCenter.display	コストセンターの名前 データタイプ：文字列
costCenter.value	コストセンターレコードの sys_id。 データタイプ：文字列
costCenter.$ref	コストセンターの参照 URI。 データタイプ：文字列
department	ユーザーの関連する部門に関する詳細。 データタイプ：オブジェクト "department": { "display": "String", "value": "String", "$ref": "String" }
department.display	部門の名前。 データタイプ：文字列
department.value	部門レコードの sys_id。 データタイプ：文字列
department.$ref	部門の参照 URI。 データタイプ：文字列
employeeNumber	数値または英数字の従業員番号。 データタイプ：文字列
gender	ユーザーの性別 (男性、女性など)。 データタイプ：文字列
location	ユーザーの関連する場所に関する詳細。 データタイプ：オブジェクト "location": { "display": "String", "value": "String", "$ref": "String" }
location.display	場所の名前。 データタイプ：文字列
location.value	場所レコードの sys_id。 データタイプ：文字列
location.$ref	場所の参照 URI。 データタイプ：文字列
manager	ユーザーの関連するマネージャーに関する詳細。 データタイプ：オブジェクト "manager": { "display": "String", "value": "String", "$ref": "String" }
manager.display	マネージャーの名前。 データタイプ：文字列
manager.value	マネージャーレコードの sys_id。 データタイプ：文字列
manager.$ref	マネージャーの参照 URI。 データタイプ：文字列

cURL 要求

次の例は、ユーザーレコード内の値を追加、削除、および置き換える方法を示しています。

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

応答：

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

クロスドメイン ID 管理システム (SCIM) プロトコルを使用して、ServiceNow インスタンスのユーザー [sys_user] テーブルにユーザーレコードを作成します。

注:

RFC7643 仕様に記載されている検索および一括変更機能は、このエンドポイントではサポートされていません。

URL 形式

バージョニングされた URL：/api/now/{api_version}/scim/Users

デフォルトの URL：/api/now/scim/Users

注:

利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

サポートされている要求パラメーター

表 : 73. パスパラメーター

名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列

表 : 74. クエリパラメーター

名前	説明
attributes	応答で返すカンマ区切りのフィールドのリストです。他のフィールドは返されません。 excludedAttributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：excludedAttributes が指定されていない限り、すべてのフィールドを返します。
excludedAttributes	応答で返されるレコードから除外するフィールドのカンマ区切りのリスト。他のすべてのフィールドが返されます。 attributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：どのフィールドも除外しません。

表 : 75. 要求本文パラメーター (XML または JSON)

名前	説明
active	関連するユーザーが ServiceNow インスタンス内でアクティブかどうかを示すフラグ。 可能な値： true：ユーザーはアクティブです。 false：ユーザーは非アクティブです。 データタイプ：ブール
住所	ユーザーの現在のメールアドレスの詳細。 データタイプ：オブジェクト "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" }
addresses.country	国名。 データタイプ：文字列
addresses.locality	市区町村名。 データタイプ：文字列
addresses.postalCode	郵便番号。 データタイプ：文字列
addresses.region	都道府県。 データタイプ：文字列
addresses.streetAddress	完全な所在地住所。これには、家屋番号、番地、私書箱、および複数行の拡張された所在地住所情報を含めることができます。 データタイプ：文字列
addresses.type	住所のタイプ。現在は home のみをサポートしています。 データタイプ：文字列
displayName	ユーザーの表示名。この値は、 name フィールドを連結することによって自動的に生成されます。 データタイプ：文字列
メール	ユーザーに関連付けられているメールアカウントのリスト。 データタイプ：オブジェクトのアレイ "emails:" [ { "type": "String", "value": "String" } ]
emails.type	ユーザーのメールタイプ。現在、「work」のタイプのみがサポートされています。 データタイプ：文字列
emails.value	ユーザーのメールアドレス。これは関連付けられたユーザーの一意のキーです。 データタイプ：文字列
externalId	ユーザーをプロビジョニングするエンティティによってユーザーにアサインされた一意の識別子。 データタイプ：文字列
name	ユーザーの名前情報。 データタイプ：オブジェクト "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" }
name.familyName	ユーザーの姓。 データタイプ：文字列
name.givenName	ユーザーの名。 データタイプ：文字列
name.honorificPrefix	ユーザーの敬称または役職 (Dr.、Bishop、Baron など)。 データタイプ：文字列
name.middle	ユーザーのミドルネーム。 データタイプ：文字列
phoneNumbers	ユーザーに関連付けられた電話番号のリスト。 データタイプ：オブジェクトのアレイ "phoneNumbers": [ { "type": "String", "value": "String" } ]
phoneNumbers.type	電話番号のタイプ。 可能な値： ホーム mobile work データタイプ：文字列
phoneNumbers.value	ユーザーの電話番号。 データタイプ：文字列
preferredLanguage	ユーザーの優先される話し/書き言葉。 データタイプ：文字列
timezone	ユーザーのタイムゾーン。 データタイプ：文字列
title	ユーザーの役職 (CEO や社長など)。 データタイプ：文字列
userName	必須です。 関連付けられたユーザーの一意のユーザー名。 データタイプ：文字列
userType	ユーザータイプ。この値は、組織とユーザーの関係を識別するために使用されます。 これは任意の値にできますが、一般的な値には次のようなものがあります。 契約社員 従業員 インターン 一時 外部 不明 データタイプ：文字列
拡張スキーマ
company	ユーザーの関連する会社に関する詳細。 データタイプ：オブジェクト "company": { "value": "String" }
company.value	会社が投稿に含まれている場合は必須です。 会社レコードの sys_id。 データタイプ：文字列
costCenter	ユーザーの関連するコストセンターに関する詳細。 データタイプ：オブジェクト "costCenter": { "value": "String" }
costCenter.value	costCenter が投稿に含まれている場合は必須です。 コストセンターレコードの sys_id。 データタイプ：文字列
department	ユーザーの関連する部門に関する詳細。 データタイプ：オブジェクト "department": { "value": "String" }
department.value	部門が投稿に含まれている場合は必須です。 部門レコードの sys_id。 データタイプ：文字列
employeeNumber	数値または英数字の従業員番号。 データタイプ：文字列
gender	ユーザーの性別 (男性、女性など)。 データタイプ：文字列
location	ユーザーの関連する場所に関する詳細。 データタイプ：オブジェクト "location": { "value": "String" }
location.value	場所が投稿に含まれている場合は必須です。 場所レコードの sys_id。 データタイプ：文字列
manager	ユーザーの関連するマネージャーに関する詳細。 データタイプ：オブジェクト "manager": { "value": "String" }
manager.value	マネージャーが投稿に含まれている場合は必須です。 マネージャーレコードの sys_id。 データタイプ：文字列

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

表 : 76. 要求ヘッダー

ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/scim+json。 デフォルト： application/json
Content-Type	要求本文のデータ形式。サポートされるタイプ：application/json または application/scim+json。 デフォルト： application/json

表 : 77. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 78. ステータスコード

ステータスコード	説明
201	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
409	ユーザーが既に存在していますuserName パラメーターは一意である必要があります。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON または XML)

名前	説明
active	関連するユーザーが ServiceNow インスタンス内でアクティブかどうかを示すフラグ。 可能な値： true：ユーザーはアクティブです。 false：ユーザーは非アクティブです。 データタイプ：ブール
住所	ユーザーの現在のメールアドレスの詳細。 データタイプ：オブジェクト "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" }
addresses.country	国名。 データタイプ：文字列
addresses.locality	市区町村名。 データタイプ：文字列
addresses.postalCode	郵便番号。 データタイプ：文字列
addresses.region	都道府県。 データタイプ：文字列
addresses.streetAddress	完全な所在地住所。これには、家屋番号、番地、私書箱、および複数行の拡張された所在地住所情報を含めることができます。 データタイプ：文字列
addresses.type	住所のタイプ。現在は home のみをサポートしています。 データタイプ：文字列
displayName	ユーザーの表示名。この値は、 name フィールドを連結することによって自動的に生成されます。 データタイプ：文字列
メール	ユーザーに関連付けられているメールアカウントのリスト。 データタイプ：オブジェクトのアレイ "emails:" [ { "type": "String", "value": "String" } ]
emails.type	ユーザーのメールタイプ。現在、「work」のタイプのみがサポートされています。 データタイプ：文字列
emails.value	ユーザーのメールアドレス。これは関連付けられたユーザーの一意のキーです。 データタイプ：文字列
errors	要求の処理中に発生した可能性のあるエラーを説明する応答。 データタイプ：オブジェクト "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" }
errors.detail	要求が失敗した理由に関する詳細なエラーメッセージ。 データタイプ：文字列
errors.scimType	SCIM エラーの詳細キーワード。 データタイプ：文字列
errors.schemas	エラー応答の処理に使用される SCIM スキーマの URI。 データタイプ：文字列のアレイ
errors.status	エラー応答の HTTP ステータスコード。 データタイプ：文字列
externalId	ユーザーをプロビジョニングするエンティティによってユーザーにアサインされた一意の識別子。 データタイプ：文字列
groups	直接メンバーシップ、ネストされたグループ、または動的な計算を介してユーザーが属しているグループのリスト。 データタイプ：オブジェクトのアレイ "groups": [ { "display": "String", "type": "String", "value": "String", "$ref": "String" } ]
groups.display	関連付けられたグループの名前。 データタイプ：文字列
groups.type	直接または間接など、グループの関連付けのタイプ。 データタイプ：文字列
groups.value	関連付けられたグループレコードの sys_id。 データタイプ：文字列
groups.$ref	関連付けられたグループの URI。 データタイプ：文字列
id	関連付けられたユーザーレコードの sys_id。 データタイプ：文字列
meta	ユーザーに関するメタデータ。 データタイプ：オブジェクト "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
meta.created	ユーザーレコードが作成された日時。 データタイプ：文字列
meta.lastModified	ユーザーレコードが最後に変更された日時。 データタイプ：文字列
meta.location	取得されるユーザーの URI。 データタイプ：文字列
meta.resourceType	SCIM ユーザーのリソースタイプ。 データタイプ：文字列
name	ユーザーの名前情報。 データタイプ：オブジェクト "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" }
name.familyName	ユーザーの姓。 データタイプ：文字列
name.givenName	ユーザーの名。 データタイプ：文字列
name.honorificPrefix	ユーザーの敬称または役職 (Dr.、Bishop、Baron など)。 データタイプ：文字列
name.middle	ユーザーのミドルネーム。 データタイプ：文字列
phoneNumbers	ユーザーに関連付けられた電話番号のリスト。 データタイプ：オブジェクトのアレイ "phoneNumbers": [ { "type": "String", "value": "String" } ]
phoneNumbers.type	電話番号のタイプ。 可能な値： ホーム mobile work データタイプ：文字列
phoneNumbers.value	ユーザーの電話番号。 データタイプ：文字列
preferredLanguage	ユーザーの優先される話し/書き言葉。 データタイプ：文字列
schemas	要求の処理に使用される SCIM ユーザースキーマの URI のリスト。 データタイプ：文字列のアレイ
timezone	ユーザーのタイムゾーン。 データタイプ：文字列
title	ユーザーの役職 (CEO や社長など)。 データタイプ：文字列
userName	関連付けられたユーザーの一意のユーザー名。 データタイプ：文字列
userType	ユーザータイプ。この値は、組織とユーザーの関係を識別するために使用されます。 これは任意の値にできますが、一般的な値には次のようなものがあります。 契約社員 従業員 インターン 一時 外部 不明 データタイプ：文字列

POST ユーザーへの cURL 要求

この例は、ユーザー [sys_user] テーブルにユーザー Jack Sparrow を POST する方法を示しています。

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

応答：

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

クロスドメイン ID 管理システム (SCIM) プロトコルを使用して、ServiceNow インスタンスのユーザー [sys_user] テーブルの指定されたユーザーレコードを更新します。

URL 形式

バージョニングされた URL：/api/now/{api_version}/scim/Users/{user_id}

デフォルトの URL：/api/now/scim/Users/{user_id}

注:

利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

サポートされている要求パラメーター

表 : 79. パスパラメーター

名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列
user_id	更新するユーザーレコードの sys_id。 データタイプ：文字列 テーブル:ユーザー [sys_user]

表 : 80. クエリパラメーター

名前	説明
attributes	応答で返すカンマ区切りのフィールドのリストです。他のフィールドは返されません。 excludedAttributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：excludedAttributes が指定されていない限り、すべてのフィールドを返します。
excludedAttributes	応答で返されるレコードから除外するフィールドのカンマ区切りのリスト。他のすべてのフィールドが返されます。 attributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：どのフィールドも除外しません。

表 : 81. 要求本文パラメーター (JSON)

名前	説明
active	関連するユーザーが ServiceNow インスタンス内でアクティブかどうかを示すフラグ。 可能な値： true：ユーザーはアクティブです。 false：ユーザーは非アクティブです。 データタイプ：ブール
住所	ユーザーの現在のメールアドレスの詳細。 データタイプ：オブジェクト "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" }
addresses.country	国名。 データタイプ：文字列
addresses.locality	市区町村名。 データタイプ：文字列
addresses.postalCode	郵便番号。 データタイプ：文字列
addresses.region	都道府県。 データタイプ：文字列
addresses.streetAddress	完全な所在地住所。これには、家屋番号、番地、私書箱、および複数行の拡張された所在地住所情報を含めることができます。 データタイプ：文字列
addresses.type	住所のタイプ。現在は home のみをサポートしています。 データタイプ：文字列
displayName	ユーザーの表示名。この値は、 name フィールドを連結することによって自動的に生成されます。 データタイプ：文字列
メール	ユーザーに関連付けられているメールアカウントのリスト。 データタイプ：オブジェクトのアレイ "emails:" [ { "type": "String", "value": "String" } ]
emails.type	ユーザーのメールタイプ。現在、「work」のタイプのみがサポートされています。 データタイプ：文字列
emails.value	ユーザーのメールアドレス。これは関連付けられたユーザーの一意のキーです。 データタイプ：文字列
externalId	ユーザーをプロビジョニングするエンティティによってユーザーにアサインされた一意の識別子。 データタイプ：文字列
name	ユーザーの名前情報。 データタイプ：オブジェクト "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" }
name.familyName	ユーザーの姓。 データタイプ：文字列
name.givenName	ユーザーの名。 データタイプ：文字列
name.honorificPrefix	ユーザーの敬称または役職 (Dr.、Bishop、Baron など)。 データタイプ：文字列
name.middle	ユーザーのミドルネーム。 データタイプ：文字列
phoneNumbers	ユーザーに関連付けられた電話番号のリスト。 データタイプ：オブジェクトのアレイ "phoneNumbers": [ { "type": "String", "value": "String" } ]
phoneNumbers.type	電話番号のタイプ。 可能な値： ホーム mobile work データタイプ：文字列
phoneNumbers.value	ユーザーの電話番号。 データタイプ：文字列
preferredLanguage	ユーザーの優先される話し/書き言葉。 データタイプ：文字列
timezone	ユーザーのタイムゾーン。 データタイプ：文字列
title	ユーザーの役職 (CEO や社長など)。 データタイプ：文字列
userName	必須です。 関連付けられたユーザーの一意のユーザー名。 データタイプ：文字列
userType	ユーザータイプ。この値は、組織とユーザーの関係を識別するために使用されます。 これは任意の値にできますが、一般的な値には次のようなものがあります。 契約社員 従業員 インターン 一時 外部 不明 データタイプ：文字列
拡張スキーマ
company	ユーザーの関連する会社に関する詳細。 データタイプ：オブジェクト "company": { "value": "String" }
company.value	会社が投稿に含まれている場合は必須です。 会社レコードの sys_id。 データタイプ：文字列
costCenter	ユーザーの関連するコストセンターに関する詳細。 データタイプ：オブジェクト "costCenter": { "value": "String" }
costCenter.value	costCenter が投稿に含まれている場合は必須です。 コストセンターレコードの sys_id。 データタイプ：文字列
department	ユーザーの関連する部門に関する詳細。 データタイプ：オブジェクト "department": { "value": "String" }
department.value	部門が投稿に含まれている場合は必須です。 部門レコードの sys_id。 データタイプ：文字列
employeeNumber	数値または英数字の従業員番号。 データタイプ：文字列
gender	ユーザーの性別 (男性、女性など)。 データタイプ：文字列
location	ユーザーの関連する場所に関する詳細。 データタイプ：オブジェクト "location": { "value": "String" }
location.value	場所が投稿に含まれている場合は必須です。 場所レコードの sys_id。 データタイプ：文字列
manager	ユーザーの関連するマネージャーに関する詳細。 データタイプ：オブジェクト "manager": { "value": "String" }
manager.value	マネージャーが投稿に含まれている場合は必須です。 マネージャーレコードの sys_id。 データタイプ：文字列

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

表 : 82. 要求ヘッダー

ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/scim+json。 デフォルト： application/json
Content-Type	要求本文のデータ形式。サポートされるタイプ：application/json または application/scim+json。 デフォルト： application/json

表 : 83. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 84. ステータスコード

ステータスコード	説明
200	成功。要求が正常に処理されました。
404	見つかりません。要求されたアイテムが見つかりませんでした。
409	ユーザーが既に存在していますuserName パラメーターは一意である必要があります。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON)

名前	説明
active	関連するユーザーが ServiceNow インスタンス内でアクティブかどうかを示すフラグ。 可能な値： true：ユーザーはアクティブです。 false：ユーザーは非アクティブです。 データタイプ：ブール
住所	ユーザーの現在のメールアドレスの詳細。 データタイプ：オブジェクト "addresses": { "country": "String", "locality": "String", "postalCode": "String", "region": "String", "streetAddress": "String", "type": "String" }
addresses.country	国名。 データタイプ：文字列
addresses.locality	市区町村名。 データタイプ：文字列
addresses.postalCode	郵便番号。 データタイプ：文字列
addresses.region	都道府県。 データタイプ：文字列
addresses.streetAddress	完全な所在地住所。これには、家屋番号、番地、私書箱、および複数行の拡張された所在地住所情報を含めることができます。 データタイプ：文字列
addresses.type	住所のタイプ。現在は home のみをサポートしています。 データタイプ：文字列
displayName	ユーザーの表示名。この値は、 name フィールドを連結することによって自動的に生成されます。 データタイプ：文字列
メール	ユーザーに関連付けられているメールアカウントのリスト。 データタイプ：オブジェクトのアレイ "emails:" [ { "type": "String", "value": "String" } ]
emails.type	ユーザーのメールタイプ。現在、「work」のタイプのみがサポートされています。 データタイプ：文字列
emails.value	ユーザーのメールアドレス。これは関連付けられたユーザーの一意のキーです。 データタイプ：文字列
errors	要求の処理中に発生した可能性のあるエラーを説明する応答。 データタイプ：オブジェクト "errors": { "details": "String", "schemas": "String", "scimType": "String", "status": "String" }
errors.detail	要求が失敗した理由に関する詳細なエラーメッセージ。 データタイプ：文字列
errors.scimType	SCIM エラーの詳細キーワード。 データタイプ：文字列
errors.schemas	エラー応答の処理に使用される SCIM スキーマの URI。 データタイプ：文字列のアレイ
errors.status	エラー応答の HTTP ステータスコード。 データタイプ：文字列
externalId	ユーザーをプロビジョニングするエンティティによってユーザーにアサインされた一意の識別子。 データタイプ：文字列
groups	直接メンバーシップ、ネストされたグループ、または動的な計算を介してユーザーが属しているグループのリスト。 データタイプ：オブジェクトのアレイ "groups": [ { "display": "String", "type": "String", "value": "String", "$ref": "String" } ]
groups.display	関連付けられたグループの名前。 データタイプ：文字列
groups.type	直接または間接など、グループの関連付けのタイプ。 データタイプ：文字列
groups.value	関連付けられたグループレコードの sys_id。 データタイプ：文字列
groups.$ref	関連付けられたグループの URI。 データタイプ：文字列
id	関連付けられたユーザーレコードの sys_id。 データタイプ：文字列
meta	ユーザーに関するメタデータ。 データタイプ：オブジェクト "meta": { "created": "String", "lastModified": "String", "location": String", "resourceType": String" }
meta.created	ユーザーレコードが作成された日時。 データタイプ：文字列
meta.lastModified	ユーザーレコードが最後に変更された日時。 データタイプ：文字列
meta.location	取得されるユーザーの URI。 データタイプ：文字列
meta.resourceType	SCIM ユーザーのリソースタイプ。 データタイプ：文字列
name	ユーザーの名前情報。 データタイプ：オブジェクト "name": { "familyName": "String", "givenName": "String", "honorificPrefix": "String", "middleName": "String" }
name.familyName	ユーザーの姓。 データタイプ：文字列
name.givenName	ユーザーの名。 データタイプ：文字列
name.honorificPrefix	ユーザーの敬称または役職 (Dr.、Bishop、Baron など)。 データタイプ：文字列
name.middle	ユーザーのミドルネーム。 データタイプ：文字列
phoneNumbers	ユーザーに関連付けられた電話番号のリスト。 データタイプ：オブジェクトのアレイ "phoneNumbers": [ { "type": "String", "value": "String" } ]
phoneNumbers.type	電話番号のタイプ。 可能な値： ホーム mobile work データタイプ：文字列
phoneNumbers.value	ユーザーの電話番号。 データタイプ：文字列
preferredLanguage	ユーザーの優先される話し/書き言葉。 データタイプ：文字列
schemas	要求の処理に使用される SCIM ユーザースキーマの URI のリスト。 データタイプ：文字列のアレイ
timezone	ユーザーのタイムゾーン。 データタイプ：文字列
title	ユーザーの役職 (CEO や社長など)。 データタイプ：文字列
userName	関連付けられたユーザーの一意のユーザー名。 データタイプ：文字列
userType	ユーザータイプ。この値は、組織とユーザーの関係を識別するために使用されます。 これは任意の値にできますが、一般的な値には次のようなものがあります。 契約社員 従業員 インターン 一時 外部 不明 データタイプ：文字列

返される拡張パラメーター

名前	説明
company	ユーザーの関連する会社に関する詳細。 データタイプ：オブジェクト "company": { "display": "String", "value": "String", "$ref": "String" }
company.display	会社の名前 データタイプ：文字列
company.value	会社レコードの sys_id。 データタイプ：文字列
company.$ref	会社の参照 URI。 データタイプ：文字列
costCenter	ユーザーの関連するコストセンターに関する詳細。 データタイプ：オブジェクト "costCenter": { "display": "String", "value": "String", "$ref": "String" }
costCenter.display	コストセンターの名前 データタイプ：文字列
costCenter.value	コストセンターレコードの sys_id。 データタイプ：文字列
costCenter.$ref	コストセンターの参照 URI。 データタイプ：文字列
department	ユーザーの関連する部門に関する詳細。 データタイプ：オブジェクト "department": { "display": "String", "value": "String", "$ref": "String" }
department.display	部門の名前。 データタイプ：文字列
department.value	部門レコードの sys_id。 データタイプ：文字列
department.$ref	部門の参照 URI。 データタイプ：文字列
employeeNumber	数値または英数字の従業員番号。 データタイプ：文字列
gender	ユーザーの性別 (男性、女性など)。 データタイプ：文字列
location	ユーザーの関連する場所に関する詳細。 データタイプ：オブジェクト "location": { "display": "String", "value": "String", "$ref": "String" }
location.display	場所の名前。 データタイプ：文字列
location.value	場所レコードの sys_id。 データタイプ：文字列
location.$ref	場所の参照 URI。 データタイプ：文字列
manager	ユーザーの関連するマネージャーに関する詳細。 データタイプ：オブジェクト "manager": { "display": "String", "value": "String", "$ref": "String" }
manager.display	マネージャーの名前。 データタイプ：文字列
manager.value	マネージャーレコードの sys_id。 データタイプ：文字列
manager.$ref	マネージャーの参照 URI。 データタイプ：文字列

PUT を使用してユーザー情報を更新する cURL 要求

この例は、PUT エンドポイントを使用して既存のユーザーの情報を更新する方法を示しています。

curl -X PUT \
  https://instance-servicenow.com/api/now/scim/Users/cdfef423e0423010f8778ac6d674f5ae \
  -d '{
  "schemas": [
    "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User",
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "externalId": "123457",
  "userName": "john.Doe",
  "name": {
    "familyName": "Doe",
    "givenName": "John"
  },
  "title": "Sir",
  "preferredLanguage": "en",
  "timezone": "ET",
  "active": true,
  "emails": [
    {
      "value": "[e-mail]",
      "display": null,
      "type": "work",
      "primary": true
    }
  ],
  "phoneNumbers": [
    {
      "value": "9977553312",
      "type": "mobile",
      "primary": true
    }
  ],
  "urn:ietf:params:scim:schemas:extension:servicenow:2.0:User": {
    "gender": "Male",
    "employeeNumber" : "13453",
    "location" : {
      "value" : "0002c0a93790200044e0bfc8bcbe5df5"
    },
    "company" : {
      "value" : "81fd65ecac1d55eb42a426568fc87a63"
    },
    "costCenter" : {
      "value" : "7fb1cc99c0a80a6d30c04574d14c0acf"
    },
    "department" : {
      "value":"221db0edc611228401760aec06c9d929"
    }
  }
}'

応答：

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

関連する ServiceNow インスタンスでサポートされているすべてのクロスドメイン ID 管理システム (SCIM) リソースタイプに関する情報を取得します。

これはパブリックエンドポイントであり、アクセスするためにロールは必要ありません。

URL 形式

バージョニングされた URL：/api/now/{api_version}/scim/ResourceTypes

デフォルトの URL：/api/now/scim/ResourceTypes

注:

利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

サポートされている要求パラメーター

表 : 85. パスパラメーター

名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列

表 : 86. クエリパラメーター

名前	説明
なし

表 : 87. 要求本文パラメーター (JSON)

名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

表 : 88. 要求ヘッダー

ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/scim+json。 デフォルト： application/json

表 : 89. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 90. ステータスコード

ステータスコード	説明
200	成功。要求が正常に処理されました。

応答本文のパラメーター (JSON)

名前	説明
itemsPerPage	返される結果で返されるレコードの数。 データタイプ：数値
Resources	利用可能なリソースタイプのリスト。 データタイプ：オブジェクトのアレイ "Resources": [ { "description": "String", "endpoint": "String", "id": "String", "meta": {Object}, "name": "String", "schema": "String" "schemas": [Array], "schemaExtensions": [Array] } ]
Resources.description	リソースタイプの簡単な説明。 データタイプ：文字列
Resources.endpoint	サービスプロバイダーのベース URL に相対的な HTTP アドレス可能なエンドポイントの名前 (「Users」など)。 データタイプ：文字列
Resources.id	リソースの一意の識別子。GET /scim/ResourceType/{resource_id} エンドポイントを呼び出すときに、この属性を使用します。 データタイプ：文字列
Resources.meta	関連付けられたリソースをさらに説明する情報。 データタイプ：オブジェクト "metadata": { "location": "String", "resourceType": "String" }
Resources.meta.location	関連付けられた ServiceNow インスタンス上の関連付けられたリソースタイプの URI。 データタイプ：文字列
Resources.meta.resourceType	常に「ResourceType」。 データタイプ：文字列
Resources.name	ユーザーやグループなどのリソースタイプの名前。 データタイプ：文字列
Resources.schema	リソースタイプのプライマリ/ベーススキーマ URI。例："urn:ietf:params:scim:schemas:core:2.0:User"。 データタイプ：文字列
Resources.schemas	/ResourceType 要求を処理するために使用されるスキーマ。例："urn:ietf:params:scim:schemas:core:2.0:ResourceType"。 データタイプ：文字列
Resources.schemaExtensions	関連するリソースタイプに適用されるスキーマ拡張のリスト。例："urn:ietf:params:scim:schemas:extension: servicenow:2.0:User"。 データタイプ：オブジェクトのアレイ "schemaExtensions": { "required": Boolean, "schema": "String" }
Resources.schemaExtensions.required	リソースタイプにスキーマ拡張が必要かどうかを示すフラグ。 可能な値： true：このタイプのリソースには、このスキーマ拡張が含まれている必要があり、さらにこのスキーマ拡張で必須として宣言された属性が含まれている必要があります。 false：このタイプのリソースはこのスキーマ拡張を省略できます。 データタイプ：ブール
Resources.schemaExtensions.schema	拡張スキーマの URI。例："urn:ietf:params:scim:schemas:extension:servicenow: 2.0:User"。 データタイプ：文字列
schemas	要求に対するリスト応答の処理に使用されるスキーマ。例："urn:ietf:params:scim:api:messages:2.0:ListResponse" データタイプ：文字列
startIndex	レコードが取得されたリソーステーブルへの 1 ベースのインデックス。 データタイプ：文字列
totalResults	要求に一致するレコードの合計数。 データタイプ：数値

cURL 要求

次の例は、ServiceNow インスタンスでサポートされている SCIM リソースタイプを取得する方法を示しています。

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

応答：

{
  "schemas":[
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults":6,
  "Resources":[
    {
      "schemas":[
        "urn:ietf:params:scim:schemas:core:2.0:ResourceType"
      ],
      "id":"User",
      "name":"User",
      "description":"User Account",
      "endpoint":"/Users",
      "schema":"urn:ietf:params:scim:schemas:core:2.0:User",
      "schemaExtensions":[
        {
          "schema":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
          "required":false
        },
        {
          "schema":"urn:ietf:params:scim:schemas:extension:servicenow:2.0:User",
          "required":false
        }
      ],
      "meta":{
        "resourceType":"ResourceType",
        "location":"https://instance-servicenow.com/api/now/scim/ResourceTypes/User"
      }
    },
    {
      "schemas":[
        "urn:ietf:params:scim:schemas:core:2.0:ResourceType"
      ],
      "id":"Group",
      "name":"Group",
      "description":"Group",
      "endpoint":"/Groups",
      "schema":"urn:ietf:params:scim:schemas:core:2.0:Group",
      "meta":{
        "resourceType":"ResourceType",
        "location":"https://instance-servicenow.service-now.com/api/now/scim/ResourceTypes/Group"
      }
    },
    {
      "schemas":[
        "urn:ietf:params:scim:schemas:core:2.0:ResourceType"
      ],
      "id":"Company",
      "name":"Company",
      "description":"Company",
      "endpoint":"/Companies",
      "schema":"urn:ietf:params:scim:schemas:custom:servicenow:2.0:Company",
      "meta":{
        "resourceType":"ResourceType",
        "location":"https://instance-servicenow.com/api/now/scim/ResourceTypes/Company"
      }
    },
    {
      "schemas":[
        "urn:ietf:params:scim:schemas:core:2.0:ResourceType"
      ],
      "id":"Department",
      "name":"Department",
      "description":"Department",
      "endpoint":"/Departments",
      "schema":"urn:ietf:params:scim:schemas:custom:servicenow:2.0:Department",
      "meta":{
        "resourceType":"ResourceType",
        "location":"https://instance-servicenow.com/api/now/scim/ResourceTypes/Department"
      }
    },
    {
      "schemas":[
        "urn:ietf:params:scim:schemas:core:2.0:ResourceType"
      ],
      "id":"CostCenter",
      "name":"CostCenter",
      "description":"CostCenter",
      "endpoint":"/CostCenters",
      "schema":"urn:ietf:params:scim:schemas:custom:servicenow:2.0:CostCenter",
      "meta":{
        "resourceType":"ResourceType",
        "location":"https://instance-servicenow.com/api/now/scim/ResourceTypes/CostCenter"
      }
    },
    {
      "schemas":[
        "urn:ietf:params:scim:schemas:core:2.0:ResourceType"
      ],
      "id":"Location",
      "name":"Location",
      "description":"Location",
      "endpoint":"/Locations",
      "schema":"urn:ietf:params:scim:schemas:custom:servicenow:2.0:Location",
      "meta":{
        "resourceType":"ResourceType",
        "location":"https://instance-servicenow.com/api/now/scim/ResourceTypes/Location"
      }
    }
  ],
  "startIndex":1,
  "itemsPerPage":6
}

SCIM - GET /scim/ResourceTypes/{ResourceName}

指定されたクロスドメイン ID 管理システム (SCIM) リソースタイプに関する情報を取得します。

これはパブリックエンドポイントであり、アクセスするためにロールは必要ありません。

URL 形式

バージョニングされた URL：/api/now/{api_version}/scim/ResourceTypes/{ResourceName}

デフォルトの URL：/api/now/scim/ResourceTypes/{ResourceName}

注:

利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

サポートされている要求パラメーター

表 : 91. パスパラメーター

名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列
ResourceName	取得するリソースタイプの一意の ID。 有効な値： 会社 CostCenter 部門 グループ 場所 ユーザー データタイプ：文字列

表 : 92. クエリパラメーター

名前	説明
なし

表 : 93. 要求本文パラメーター (JSON)

名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

表 : 94. 要求ヘッダー

ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/scim+json。 デフォルト： application/json

表 : 95. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 96. ステータスコード

ステータスコード	説明
200	成功。要求が正常に処理されました。
404	見つかりません。要求されたアイテムが見つかりませんでした。

応答本文のパラメーター (JSON)

名前	説明
description	リソースタイプの簡単な説明。 データタイプ：文字列
endpoint	サービスプロバイダーのベース URL に相対的な HTTP アドレス可能なエンドポイントの名前 (「Companies」など)。 データタイプ：文字列
id	リソースの一意の識別子。GET /scim/ResourceType/{resource_id} エンドポイントを呼び出すときに、この属性を使用します。 データタイプ：文字列
meta	関連付けられたリソースをさらに説明する情報。 データタイプ：オブジェクト "metadata": { "location": "String", "resourceType": "String" }
meta.location	関連付けられた ServiceNow インスタンス上の関連付けられたリソースタイプの URI。 データタイプ：文字列
meta.resourceType	常に「ResourceType」。 データタイプ：文字列
name	ユーザーやグループなどのリソースタイプの名前。 データタイプ：文字列
schema	リソースタイプのプライマリ/ベーススキーマ URI。例："urn:ietf:params:scim:schemas:core:2.0:User"。 データタイプ：文字列
schemas	/ResourceType 要求を処理するために使用されるスキーマ。例："urn:ietf:params:scim:schemas:core:2.0:ResourceType"。 データタイプ：文字列
schemaExtensions	関連するリソースタイプに適用されるスキーマ拡張のリスト。例："urn:ietf:params:scim:schemas:extension: servicenow:2.0:User"。 データタイプ：オブジェクトのアレイ "schemaExtensions": { "required": Boolean, "schema": "String" }
schemaExtensions.required	リソースタイプにスキーマ拡張が必要かどうかを示すフラグ。 可能な値： true：このタイプのリソースには、このスキーマ拡張が含まれている必要があり、さらにこのスキーマ拡張で必須として宣言された属性が含まれている必要があります。 false：このタイプのリソースはこのスキーマ拡張を省略できます。 データタイプ：ブール
schemaExtensions.schema	拡張スキーマの URI。例："urn:ietf:params:scim:schemas:extension:servicenow: 2.0:User"。 データタイプ：文字列
schemas	要求に対するリスト応答の処理に使用されるスキーマ。例："urn:ietf:params:scim:api:messages:2.0:ListResponse" データタイプ：文字列

cURL 要求

次の例は、ServiceNow インスタンスからユーザー SCIM リソースタイプを取得する方法を示しています。

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

応答：

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

ServiceNow インスタンスでサポートされているすべてのクロスドメイン ID 管理システム (SCIM) リソーススキーマに関する情報を取得します。これらのスキーマは、各リソースタイプで使用可能な属性を定義します。

これはパブリックエンドポイントであり、アクセスするためにロールは必要ありません。

URL 形式

バージョニングされた URL：/api/now/{api_version}/scim/Schemas

デフォルトの URL：/api/now/scim/Schemas

注:

利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

サポートされている要求パラメーター

表 : 97. パスパラメーター

名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列

表 : 98. クエリパラメーター

名前	説明
なし

表 : 99. 要求本文パラメーター (JSON)

名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

表 : 100. 要求ヘッダー

ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/scim+json。 デフォルト： application/json

表 : 101. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 102. ステータスコード

ステータスコード	説明
200	成功。要求が正常に処理されました。

応答本文のパラメーター (JSON)

名前	説明
標準 RFC7643 で返される結果 (Standard RFC7643 return results)	メソッドは、RFC7643 標準に準拠して結果を返します。詳細については、RFC7643 仕様の「スキーマ定義 (Schema Definition)」を参照してください。

cURL 要求

次の例は、ServiceNow インスタンスでサポートされている SCIM スキーマを取得する方法を示しています。

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

応答：

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

ServiceNow インスタンスでサポートされている指定されたクロスドメイン ID 管理システム (SCIM) リソーススキーマに関する情報を取得します。これらのスキーマは、各リソースタイプで使用可能な属性を定義します。

これはパブリックエンドポイントであり、アクセスするためにロールは必要ありません。

URL 形式

バージョニングされた URL：/api/now/{api_version}/scim/Schemas/{SchemaName}

デフォルトの URL：/api/now/scim/Schemas/{SchemaName}

注:

利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

サポートされている要求パラメーター

表 : 103. パスパラメーター

名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列
SchemaName	返されるリソーススキーマの URI。 有効な値： urn:ietf:params:scim:schemas:core:2.0:User urn:ietf:params:scim:schemas:extension: enterprise:2.0:User urn:ietf:params:scim:schemas:extension: servicenow:2.0:User urn:ietf:params:scim:schemas:core:2.0:Group urn:ietf:params:scim:schemas:custom: servicenow:2.0:Company urn:ietf:params:scim:schemas:custom: servicenow:2.0:Department urn:ietf:params:scim:schemas:custom: servicenow:2.0:CostCenter urn:ietf:params:scim:schemas:custom: servicenow:2.0:Location データタイプ：文字列

表 : 104. クエリパラメーター

名前	説明
なし

表 : 105. 要求本文パラメーター (JSON)

名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

表 : 106. 要求ヘッダー

ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/scim+json。 デフォルト： application/json

表 : 107. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 108. ステータスコード

ステータスコード	説明
200	成功。要求が正常に処理されました。
404	見つかりません。要求されたアイテムが見つかりませんでした。

応答本文のパラメーター (JSON)

名前	説明
標準 RFC7643 で返される結果 (Standard RFC7643 return results)	メソッドは、RFC7643 標準に準拠して結果を返します。詳細については、RFC7643 仕様の「スキーマ定義 (Schema Definition)」を参照してください。

cURL 要求

次の例は、ServiceNow インスタンスからコアグループ SCIM スキーマを取得する方法を示しています。

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

応答：

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

ServiceNow インスタンス内で利用可能なクロスドメイン ID 管理システム (SCIM) エンドポイントのサービス機能、構成、スキーマ、およびリソースタイプに関する情報を取得するために使用する構成メタデータを返します。

これはパブリックエンドポイントであり、アクセスするためにロールは必要ありません。

URL 形式

バージョニングされた URL：/api/now/{api_version}/scim/ServiceProviderConfig

デフォルトの URL：/api/now/scim/ServiceProviderConfig

注:

利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

サポートされている要求パラメーター

表 : 109. パスパラメーター

名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列

表 : 110. クエリパラメーター

名前	説明
なし

表 : 111. 要求本文パラメーター (JSON)

名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

表 : 112. 要求ヘッダー

ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/scim+json。 デフォルト： application/json

表 : 113. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 114. ステータスコード

ステータスコード	説明
200	成功。要求が正常に処理されました。

応答本文のパラメーター (JSON)

名前	説明
標準 RFC7643 で返される結果 (Standard RFC7643 return results)	メソッドは、RFC7643 標準に準拠して結果を返します。詳細については、RFC7643 仕様の「サービスプロバイダー構成スキーマ (Service Provider Configuration Schema)」を参照してください。

cURL 要求

次の例は、ServiceNow インスタンスの SCIM 構成メタデータを取得する方法を示しています。

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

応答：

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

クロスドメイン ID 管理システム (SCIM) プロトコルを使用して、ServiceNow インスタンス内の会社 [core_company] テーブルから 1 つ以上の会社レコードを返します。

注:

一致を返さないクエリは、totalResults が 0 に設定された状態で成功 (HTTP ステータスコード 200) を返します。

URL 形式

バージョニングされた URL：/api/now/{api_version}/scim/Companies

デフォルトの URL：/api/now/scim/Companies

注:

利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

サポートされている要求パラメーター

表 : 115. パスパラメーター

名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列

表 : 116. クエリパラメーター

名前	説明
attributes	応答で返すカンマ区切りのフィールドのリストです。他のフィールドは返されません。 excludedAttributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：excludedAttributes が指定されていない限り、すべてのフィールドを返します。
count	返されるレコードの数。負の値はゼロと解釈されます。 データタイプ：数値 最大：500 - これより大きい値を指定すると、不正な要求エラーが発生します。 デフォルト：10
excludedAttributes	応答で返されるレコードから除外するフィールドのカンマ区切りのリスト。他のすべてのフィールドが返されます。 attributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：どのフィールドも除外しません。
filter	返される結果に適用するフィルター式。フィールドフィルターは、<field_name> <operator> <"value"> として表されます。有効な演算子のリストについては、RFC7644 を参照してください。 注: NOT 演算子はこのメソッドではサポートされていません。 たとえば、名前が「Acme」で始まるすべての会社をフィルタリングするには、「displayName SW "Acme"」と入力します。 複数のフィールドフィルターを指定するには、AND オペランドを使用してフィルターを連結します。たとえば、名前が「Acme」で始まり、最終変更日が 2021 年 10 月 3 日より前であるすべての会社をフィルタリングするには、「displayName SW "Acme" AND meta.lastModified lt "2021-10-03T00:00:00Z"」と入力します。ネストされた属性を指定するには、ドット連結を使用します。 データタイプ：文字列 デフォルト：フィルタリングなし
sortBy	sortOrder パラメーターで指定する必要があります。返される結果をソートするフィールド。ソートでは大文字と小文字が区別されません。 sortBy パラメーターのフィルタリングで利用可能なパラメーターのみを使用できます。ただし、externalId は、例外であり、許可されません。 null の値の場合： 昇順でソート:null 値は先頭にソートされます。 降順でソート:null 値は一番下にソートされます。 データタイプ：文字列 デフォルト：ソートなし
sortOrder	sortBy パラメーターで指定する必要があります。sortBy パラメーターが返される結果に適用される順序。 有効な値： 昇順 降順 データタイプ：文字列 デフォルト：昇順
startIndex	レコードの取得を開始するテーブルへの 1 ベースのインデックス。たとえば、このパラメーターを 100 に設定し、count パラメーターを 20 に設定すると、エンドポイントは 100 ～ 119 のレコードを返します。 注: 1 未満に設定された値は 1 と解釈されます。 データタイプ：文字列 デフォルト：1

表 : 117. 要求本文パラメーター (JSON)

名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

表 : 118. 要求ヘッダー

ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/scim+json。 デフォルト： application/json

表 : 119. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 120. ステータスコード

ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 attributes と excludedAttributes の両方のクエリパラメーターが要求で渡されていないことを確認してください。 count パラメーターが 500 を超えないようにしてください。 すべての filter パラメーターが有効であることを確認してください。
401	権限がありません。ユーザー資格情報が間違っているか、渡されていません。

応答本文のパラメーター (JSON)

名前	説明
itemsPerPage	返される結果で返されるレコードの数。 データタイプ：数値
リソース	返されるコストセンターレコードリスト。 データタイプ：オブジェクト "Resources": { "id": "String", "meta": {Object}, "name": "String", "schemas": "String" }
Resources.id	会社レコードの sys_id。 データタイプ：文字列
Resources.meta	会社レコードに関する情報。 データタイプ：オブジェクト "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" }
Resources.meta.created	関連する会社レコードが作成された日時。 データタイプ：文字列
Resources.meta.lastModified	関連する会社レコードが最後に変更された日時。 データタイプ：文字列
Resources.meta.location	関連付けられた会社レコードの URI。 データタイプ：文字列
Resources.meta.resourceType	SCIM リソースタイプ。常に Company。 データタイプ：文字列
Resources.name	会社名。 データタイプ：文字列
Resources.schemas	要求を処理するときに使用されるスキーマ。 データタイプ：文字列
schemas	要求に対するリスト応答の処理に使用されるスキーマ。例："urn:ietf:params:scim:api:messages:2.0:ListResponse" データタイプ：文字列
startIndex	レコードが返された会社 [core_company] テーブルの 1 ベースのインデックス。 データタイプ：文字列
totalResults	要求に一致するレコードの合計数。 データタイプ：数値

cURL 要求

この例は、最初の 2 つの会社レコードを取得する方法を示しています。

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

応答：

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

クロスドメイン ID 管理システム (SCIM) プロトコルを使用して、ServiceNow インスタンス内の会社 [core_company] テーブルから指定された会社レコードを返します。

URL 形式

バージョニングされた URL：/api/now/{api_version}/scim/Companies/{company_id}

デフォルトの URL：/api/now/scim/Groups/{company_id}

注:

利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

サポートされている要求パラメーター

表 : 121. パスパラメーター

名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列
company_id	返される会社レコードの sys_id。 データタイプ：文字列

表 : 122. クエリパラメーター

名前	説明
attributes	応答で返すカンマ区切りのフィールドのリストです。他のフィールドは返されません。 excludedAttributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：excludedAttributes が指定されていない限り、すべてのフィールドを返します。
excludedAttributes	応答で返されるレコードから除外するフィールドのカンマ区切りのリスト。他のすべてのフィールドが返されます。 attributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：どのフィールドも除外しません。

表 : 123. 要求本文パラメーター (JSON)

名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

表 : 124. 要求ヘッダー

ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/scim+json。 デフォルト： application/json

表 : 125. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 126. ステータスコード

ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 attributes と excludedAttributes の両方のクエリパラメーターが要求で渡されていないことを確認してください。 count パラメーターが 500 を超えないようにしてください。 すべての filter パラメーターが有効であることを確認してください。
401	権限がありません。ユーザー資格情報が間違っているか、渡されていません。
404	見つかりません。要求されたアイテムが見つかりませんでした。

応答本文のパラメーター (JSON)

名前	説明
id	会社レコードの sys_id。 データタイプ：文字列
meta	会社レコードに関する情報。 データタイプ：オブジェクト "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" }
meta.created	関連する会社レコードが作成された日時。 データタイプ：文字列
meta.lastModified	関連する会社レコードが最後に変更された日時。 データタイプ：文字列
meta.location	関連付けられた会社レコードの URI。 データタイプ：文字列
meta.resourceType	SCIM リソースタイプ。常に Company。 データタイプ：文字列
name	会社名。 データタイプ：文字列
schemas	要求を処理するときに使用されるスキーマ。 データタイプ：文字列

cURL 要求

この例は、特定の会社レコードを取得する方法を示しています。

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

対応

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

クロスドメイン ID 管理システム (SCIM) プロトコルを使用して、ServiceNow インスタンス内のコストセンター [cmn_cost_center] テーブルから 1 つ以上のコストセンターレコードを返します。

注:

一致を返さないクエリは、totalResults が 0 に設定された状態で成功 (HTTP ステータスコード 200) を返します。

URL 形式

バージョニングされた URL：/api/now/{api_version}/scim/CostCenters

デフォルトの URL：/api/now/scim/CostCenters

注:

利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

サポートされている要求パラメーター

表 : 127. パスパラメーター

名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列

表 : 128. クエリパラメーター

名前	説明
attributes	応答で返すカンマ区切りのフィールドのリストです。他のフィールドは返されません。 excludedAttributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：excludedAttributes が指定されていない限り、すべてのフィールドを返します。
count	返されるレコードの数。負の値はゼロと解釈されます。 データタイプ：数値 最大：500 - これより大きい値を指定すると、不正な要求エラーが発生します。 デフォルト：10
excludedAttributes	応答で返されるレコードから除外するフィールドのカンマ区切りのリスト。他のすべてのフィールドが返されます。 attributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：どのフィールドも除外しません。
filter	返される結果に適用するフィルター式。フィールドフィルターは、<field_name> <operator> <"value"> として表されます。有効な演算子のリストについては、RFC7644 を参照してください。 注: NOT 演算子はこのメソッドではサポートされていません。 たとえば、名前が「HR」で始まるすべてのコストセンターをフィルタリングするには、「displayName SW "HR"」と入力します。 複数のフィールドフィルターを指定するには、AND オペランドを使用してフィルターを連結します。たとえば、名前が「HR」で始まり、最終変更日が 2021 年 10 月 3 日より前であるすべてのコストセンターをフィルタリングするには、「displayName SW "HR" AND meta.lastModified lt "2021-10-03T00:00:00Z"」と入力します。ネストされた属性を指定するには、ドット連結を使用します。 データタイプ：文字列 デフォルト：フィルタリングなし
sortBy	sortOrder パラメーターで指定する必要があります。返される結果をソートするフィールド。ソートでは大文字と小文字が区別されません。 sortBy パラメーターのフィルタリングで利用可能なパラメーターのみを使用できます。ただし、externalId は、例外であり、許可されません。 null の値の場合： 昇順でソート:null 値は先頭にソートされます。 降順でソート:null 値は一番下にソートされます。 データタイプ：文字列 デフォルト：ソートなし
sortOrder	sortBy パラメーターで指定する必要があります。sortBy パラメーターが返される結果に適用される順序。 有効な値： 昇順 降順 データタイプ：文字列 デフォルト：昇順
startIndex	レコードの取得を開始するテーブルへの 1 ベースのインデックス。たとえば、このパラメーターを 100 に設定し、count パラメーターを 20 に設定すると、エンドポイントは 100 ～ 119 のレコードを返します。 注: 1 未満に設定された値は 1 と解釈されます。 データタイプ：文字列 デフォルト：1

表 : 129. 要求本文パラメーター (SON)

名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

表 : 130. 要求ヘッダー

ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/scim+json。 デフォルト： application/json

表 : 131. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 132. ステータスコード

ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 attributes と excludedAttributes の両方のクエリパラメーターが要求で渡されていないことを確認してください。 count パラメーターが 500 を超えないようにしてください。 すべての filter パラメーターが有効であることを確認してください。
401	権限がありません。ユーザー資格情報が間違っているか、渡されていません。

応答本文のパラメーター (JSON)

名前	説明
itemsPerPage	返される結果で返されるレコードの数。 データタイプ：数値
リソース	返されるコストセンターレコードリスト。 データタイプ：オブジェクト "Resources": { "id": "String", "meta": {Object}, "name": "String", "schemas": "String" }
Resources.id	コストセンターレコードの sys_id。 データタイプ：文字列
Resources.meta	コストセンターレコードに関する情報。 データタイプ：オブジェクト "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" }
Resources.meta.created	関連するコストセンターレコードが作成された日時。 データタイプ：文字列
Resources.meta.lastModified	関連するコストセンターレコードが最後に変更された日時。 データタイプ：文字列
Resources.meta.location	関連付けられたコストセンターレコードの URI。 データタイプ：文字列
Resources.meta.resourceType	SCIM リソースタイプ。常に CostCenter。 データタイプ：文字列
Resources.name	コストセンター名。 データタイプ：文字列
Resources.schemas	要求を処理するときに使用されるスキーマ。 データタイプ：文字列
schemas	要求に対するリスト応答の処理に使用されるスキーマ。例："urn:ietf:params:scim:api:messages:2.0:ListResponse" データタイプ：文字列
startIndex	レコードが返されたコストセンター [cmn_cost_center] テーブルの 1 ベースのインデックス。 データタイプ：文字列
totalResults	要求に一致するレコードの合計数。 データタイプ：数値

cURL 要求

この例は、最初の 2 つのコストセンターレコードを取得する方法を示しています。

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

応答：

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

クロスドメイン ID 管理システム (SCIM) プロトコルを使用して、ServiceNow インスタンス内のコストセンター [cmn_cost_center] テーブルから指定されたコストセンターレコードを返します。

注:

一致を返さないクエリは、totalResults が 0 に設定された状態で成功 (HTTP ステータスコード 200) を返します。

URL 形式

バージョニングされた URL：/api/now/{api_version}/scim/CostCenters/{cost_center_id}

デフォルトの URL：/api/now/scim/CoostCenters/{cost_center_id}

注:

利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

サポートされている要求パラメーター

表 : 133. パスパラメーター

名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列
cost_center_id	返されるコストセンターレコードの sys_id。 データタイプ：文字列

表 : 134. クエリパラメーター

名前	説明
attributes	応答で返すカンマ区切りのフィールドのリストです。他のフィールドは返されません。 excludedAttributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：excludedAttributes が指定されていない限り、すべてのフィールドを返します。
excludedAttributes	応答で返されるレコードから除外するフィールドのカンマ区切りのリスト。他のすべてのフィールドが返されます。 attributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：どのフィールドも除外しません。

表 : 135. 要求本文パラメーター (JSON)

名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

表 : 136. 要求ヘッダー

ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/scim+json。 デフォルト： application/json

表 : 137. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 138. ステータスコード

ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 attributes と excludedAttributes の両方のクエリパラメーターが要求で渡されていないことを確認してください。 count パラメーターが 500 を超えないようにしてください。 すべての filter パラメーターが有効であることを確認してください。
401	権限がありません。ユーザー資格情報が間違っているか、渡されていません。
404	見つかりません。要求されたアイテムが見つかりませんでした。

応答本文のパラメーター (JSON)

名前	説明
id	コストセンターレコードの sys_id。 データタイプ：文字列
meta	コストセンターレコードに関する情報。 データタイプ：オブジェクト "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" }
meta.created	関連するコストセンターレコードが作成された日時。 データタイプ：文字列
meta.lastModified	関連するコストセンターレコードが最後に変更された日時。 データタイプ：文字列
meta.location	関連付けられたコストセンターレコードの URI。 データタイプ：文字列
meta.resourceType	SCIM リソースタイプ。常に CostCenter。 データタイプ：文字列
name	コストセンター名。 データタイプ：文字列
schemas	要求を処理するときに使用されるスキーマ。 データタイプ：文字列

cURL 要求

この例は、特定のコストセンターレコードを取得する方法を示しています。

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

応答：

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

クロスドメイン ID 管理システム (SCIM) プロトコルを使用して、ServiceNow インスタンス内の部門 [cmn_department] テーブルから 1 つ以上の部門レコードを返します。

注:

一致を返さないクエリは、totalResults が 0 に設定された状態で成功 (HTTP ステータスコード 200) を返します。

URL 形式

バージョニングされた URL：/api/now/{api_version}/scim/Departments

デフォルトの URL：/api/now/scim/Departments

注:

利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

サポートされている要求パラメーター

表 : 139. パスパラメーター

名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列

表 : 140. クエリパラメーター

名前	説明
attributes	応答で返すカンマ区切りのフィールドのリストです。他のフィールドは返されません。 excludedAttributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：excludedAttributes が指定されていない限り、すべてのフィールドを返します。
count	返されるレコードの数。負の値はゼロと解釈されます。 データタイプ：数値 最大：500 - これより大きい値を指定すると、不正な要求エラーが発生します。 デフォルト：10
excludedAttributes	応答で返されるレコードから除外するフィールドのカンマ区切りのリスト。他のすべてのフィールドが返されます。 attributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：どのフィールドも除外しません。
filter	返される結果に適用するフィルター式。フィールドフィルターは、<field_name> <operator> <"value"> として表されます。有効な演算子のリストについては、RFC7644 を参照してください。 注: NOT 演算子はこのメソッドではサポートされていません。 たとえば、名前が「Engineer」で始まるすべての部門をフィルタリングするには、「displayName SW "Engineer"」と入力します。 複数のフィールドフィルターを指定するには、AND オペランドを使用してフィルターを連結します。たとえば、名前が「Engineer」で始まり、最終変更日が 2021 年 10 月 3 日より前であるすべての部門をフィルタリングするには、「displayName SW "Engineer" AND meta.lastModified lt "2021-10-03T00:00:00Z"」と入力します。ネストされた属性を指定するには、ドット連結を使用します。 データタイプ：文字列 デフォルト：フィルタリングなし
sortBy	sortOrder パラメーターで指定する必要があります。返される結果をソートするフィールド。ソートでは大文字と小文字が区別されません。 sortBy パラメーターのフィルタリングで利用可能なパラメーターのみを使用できます。ただし、externalId は、例外であり、許可されません。 null の値の場合： 昇順でソート:null 値は先頭にソートされます。 降順でソート:null 値は一番下にソートされます。 データタイプ：文字列 デフォルト：ソートなし
sortOrder	sortBy パラメーターで指定する必要があります。sortBy パラメーターが返される結果に適用される順序。 有効な値： 昇順 降順 データタイプ：文字列 デフォルト：昇順
startIndex	レコードの取得を開始するテーブルへの 1 ベースのインデックス。たとえば、このパラメーターを 100 に設定し、count パラメーターを 20 に設定すると、エンドポイントは 100 ～ 119 のレコードを返します。 注: 1 未満に設定された値は 1 と解釈されます。 データタイプ：文字列 デフォルト：1

表 : 141. 要求本文パラメーター (JSON)

名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

表 : 142. 要求ヘッダー

ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/scim+json。 デフォルト： application/json

表 : 143. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 144. ステータスコード

ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 attributes と excludedAttributes の両方のクエリパラメーターが要求で渡されていないことを確認してください。 count パラメーターが 500 を超えないようにしてください。 すべての filter パラメーターが有効であることを確認してください。
401	権限がありません。ユーザー資格情報が間違っているか、渡されていません。

応答本文のパラメーター (JSON)

名前	説明
itemsPerPage	返される結果で返されるレコードの数。 データタイプ：数値
リソース	返される部門レコードリスト。 データタイプ：オブジェクト "Resources": { "id": "String", "meta": {Object}, "name": "String", "schemas": "String" }
Resources.id	部門レコードの sys_id。 データタイプ：文字列
Resources.meta	部門レコードに関する情報。 データタイプ：オブジェクト "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" }
Resources.meta.created	関連する部門レコードが作成された日時。 データタイプ：文字列
Resources.meta.lastModified	関連する部門レコードが最後に変更された日時。 データタイプ：文字列
Resources.meta.location	関連付けられた部門レコードの URI。 データタイプ：文字列
Resources.meta.resourceType	SCIM リソースタイプ。常に Department。 データタイプ：文字列
Resources.name	部門名。 データタイプ：文字列
Resources.schemas
schemas
startIndex	レコードが返された部門 [cmn_department] テーブルの 1 ベースのインデックス。 データタイプ：文字列
totalResults	要求に一致するレコードの合計数。 データタイプ：数値

cURL 要求

この例は、最初の 2 つの部門レコードを取得する方法を示しています。

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

応答：

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

クロスドメイン ID 管理システム (SCIM) プロトコルを使用して、ServiceNow インスタンス内の部門 [cmn_department] テーブルから指定された部門レコードを返します。

URL 形式

バージョニングされた URL：/api/now/{api_version}/scim/Departments/{department_id}

デフォルトの URL：/api/now/scim/Departments/{department_id}

注:

利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

サポートされている要求パラメーター

表 : 145. パスパラメーター

名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列
department_id	返される部門レコードの sys_id。 データタイプ：文字列

表 : 146. クエリパラメーター

名前	説明
attributes	応答で返すカンマ区切りのフィールドのリストです。他のフィールドは返されません。 excludedAttributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：excludedAttributes が指定されていない限り、すべてのフィールドを返します。
excludedAttributes	応答で返されるレコードから除外するフィールドのカンマ区切りのリスト。他のすべてのフィールドが返されます。 attributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：どのフィールドも除外しません。

表 : 147. 要求本文パラメーター (JSON)

名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

表 : 148. 要求ヘッダー

ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/scim+json。 デフォルト： application/json

表 : 149. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 150. ステータスコード

ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 attributes と excludedAttributes の両方のクエリパラメーターが要求で渡されていないことを確認してください。 count パラメーターが 500 を超えないようにしてください。 すべての filter パラメーターが有効であることを確認してください。
401	権限がありません。ユーザー資格情報が間違っているか、渡されていません。
404	見つかりません。要求されたアイテムが見つかりませんでした。

応答本文のパラメーター (JSON)

名前	説明
id	部門レコードの sys_id。 データタイプ：文字列
meta	部門レコードに関する情報。 データタイプ：オブジェクト "meta": { "created": "String", "lastModified": "String", "location": "String", "resourcType": "String" }
meta.created	関連する部門レコードが作成された日時。 データタイプ：文字列
meta.lastModified	関連する部門レコードが最後に変更された日時。 データタイプ：文字列
meta.location	関連付けられた部門レコードの URI。 データタイプ：文字列
meta.resourceType	SCIM リソースタイプ。常に Department。 データタイプ：文字列
name	部門名。 データタイプ：文字列
schemas	要求を処理するときに使用されるスキーマ。 データタイプ：文字列

cURL 要求

この例は、特定の部門レコードを取得する方法を示しています。

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

応答：

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

クロスドメイン ID 管理システム (SCIM) プロトコルを使用して、ServiceNow インスタンス内の場所 [cmn_location] テーブルから 1 つ以上の場所レコードを返します。

注:

一致を返さないクエリは、totalResults が 0 に設定された状態で成功 (HTTP ステータスコード 200) を返します。

URL 形式

バージョニングされた URL：/api/now/{api_version}/scim/Locations

デフォルトの URL：/api/now/scim/Locations

注:

利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

サポートされている要求パラメーター

表 : 151. パスパラメーター

名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列

表 : 152. クエリパラメーター

名前	説明
attributes	応答で返すカンマ区切りのフィールドのリストです。他のフィールドは返されません。 excludedAttributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：excludedAttributes が指定されていない限り、すべてのフィールドを返します。
count	返されるレコードの数。負の値はゼロと解釈されます。 データタイプ：数値 最大：500 - これより大きい値を指定すると、不正な要求エラーが発生します。 デフォルト：10
excludedAttributes	応答で返されるレコードから除外するフィールドのカンマ区切りのリスト。他のすべてのフィールドが返されます。 attributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：どのフィールドも除外しません。
filter	返される結果に適用するフィルター式。フィールドフィルターは、<field_name> <operator> <"value"> として表されます。有効な演算子のリストについては、RFC7644 を参照してください。 注: NOT 演算子はこのメソッドではサポートされていません。 たとえば、名前が「Ch」で始まるすべての場所をフィルタリングするには、「displayName SW "Ch"」と入力します。 複数のフィールドフィルターを指定するには、AND オペランドを使用してフィルターを連結します。たとえば、名前が「Ch」で始まり、最終変更日が 2021 年 10 月 3 日より前であるすべての場所をフィルタリングするには、「displayName SW "Ch" AND meta.lastModified lt "2021-10-03T00:00:00Z"」と入力します。ネストされた属性を指定するには、ドット連結を使用します。 データタイプ：文字列 デフォルト：フィルタリングなし
sortBy	sortOrder パラメーターで指定する必要があります。返される結果をソートするフィールド。ソートでは大文字と小文字が区別されません。 sortBy パラメーターのフィルタリングで利用可能なパラメーターのみを使用できます。ただし、externalId は、例外であり、許可されません。 null の値の場合： 昇順でソート:null 値は先頭にソートされます。 降順でソート:null 値は一番下にソートされます。 データタイプ：文字列 デフォルト：ソートなし
sortOrder	sortBy パラメーターで指定する必要があります。sortBy パラメーターが返される結果に適用される順序。 有効な値： 昇順 降順 データタイプ：文字列 デフォルト：昇順
startIndex	レコードの取得を開始するテーブルへの 1 ベースのインデックス。たとえば、このパラメーターを 100 に設定し、count パラメーターを 20 に設定すると、エンドポイントは 100 ～ 119 のレコードを返します。 注: 1 未満に設定された値は 1 と解釈されます。 データタイプ：文字列 デフォルト：1

表 : 153. 要求本文パラメーター (JSON)

名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

表 : 154. 要求ヘッダー

ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/scim+json。 デフォルト： application/json

表 : 155. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 156. ステータスコード

ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 attributes と excludedAttributes の両方のクエリパラメーターが要求で渡されていないことを確認してください。 count パラメーターが 500 を超えないようにしてください。 すべての filter パラメーターが有効であることを確認してください。
401	権限がありません。ユーザー資格情報が間違っているか、渡されていません。

応答本文のパラメーター (JSON)

名前	説明
itemsPerPage	返される結果で返されるレコードの数。 データタイプ：数値
リソース	返される場所レコードリスト。 データタイプ：オブジェクト "Resources": { "id": "String", "meta": {Object}, "name": "String", "schemas": "String" }
Resources.id	場所レコードの sys_id。 データタイプ：文字列
Resources.meta	場所レコードに関する情報。 データタイプ：オブジェクト "meta": { "created": "String", "lastModified": "String", "location": "String", "resourceType": "String" }
Resources.meta.created	関連する場所レコードが作成された日時。 データタイプ：文字列
Resources.meta.lastModified	関連する場所レコードが最後に変更された日時。 データタイプ：文字列
Resources.meta.location	関連付けられた場所レコードの URI。 データタイプ：文字列
Resources.meta.resourceType	SCIM リソースタイプ。常に Location。 データタイプ：文字列
Resources.name	場所の名前。 データタイプ：文字列
Resources.schemas	要求を処理するときに使用されるスキーマ。 データタイプ：文字列
schemas	要求に対するリスト応答の処理に使用されるスキーマ。例："urn:ietf:params:scim:api:messages:2.0:ListResponse" データタイプ：文字列
startIndex	レコードが返された場所 [cmn_location] テーブルの 1 ベースのインデックス。 データタイプ：文字列
totalResults	要求に一致するレコードの合計数。 データタイプ：数値

cURL 要求

この例は、最初の 2 つの会社レコードを取得する方法を示しています。

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

対応

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

クロスドメイン ID 管理システム (SCIM) プロトコルを使用して、ServiceNow インスタンス内の場所 [cmn_location] テーブルから指定された場所レコードを返します。

URL 形式

バージョニングされた URL：/api/now/{api_version}/scim/Locations/{location_id}

デフォルトの URL：/api/now/scim/Locations/{location_id}

注:

利用可能なバージョンは、 REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

サポートされている要求パラメーター

表 : 157. パスパラメーター

名前	説明
api_version	オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列
location_id	返される場所レコードの sys_id。 データタイプ：文字列

表 : 158. クエリパラメーター

名前	説明
attributes	応答で返すカンマ区切りのフィールドのリストです。他のフィールドは返されません。 excludedAttributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：excludedAttributes が指定されていない限り、すべてのフィールドを返します。
excludedAttributes	応答で返されるレコードから除外するフィールドのカンマ区切りのリスト。他のすべてのフィールドが返されます。 attributes パラメーターと一緒に使用することはできません。 データタイプ：文字列 デフォルト：どのフィールドも除外しません。

表 : 159. 要求本文パラメーター (JSON)

名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

表 : 160. 要求ヘッダー

ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/scim+json。 デフォルト： application/json

表 : 161. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 162. ステータスコード

ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 attributes と excludedAttributes の両方のクエリパラメーターが要求で渡されていないことを確認してください。 count パラメーターが 500 を超えないようにしてください。 すべての filter パラメーターが有効であることを確認してください。
401	権限がありません。ユーザー資格情報が間違っているか、渡されていません。
404	見つかりません。要求されたアイテムが見つかりませんでした。

応答本文のパラメーター (JSON)

名前	説明
id	場所レコードの sys_id。 データタイプ：文字列
meta	場所レコードに関する情報。 データタイプ：オブジェクト "meta": { "created": "String", "lastModified": "String", "location": "String", "resourceType": "String" }
meta.created	関連する場所レコードが作成された日時。 データタイプ：文字列
meta.lastModified	関連する場所レコードが最後に変更された日時。 データタイプ：文字列
meta.location	関連付けられた場所レコードの URI。 データタイプ：文字列
meta.resourceType	SCIM リソースタイプ。常に Location。 データタイプ：文字列
name	場所の名前。 データタイプ：文字列
schemas	要求を処理するときに使用されるスキーマ。 データタイプ：文字列

cURL 要求

この例は、特定の場所レコードを取得する方法を示しています。

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

応答：

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