REST APIリファレンス > プラットフォームREST APIバージョン3リソース > SCIM
  

SCIM

組織でSCIM 2.0を使用してユーザーやグループの情報をIDMCにプッシュする場合、SCIMトークンを管理し、SCIMトークンを使用してSCIM管理対象のユーザーとグループを取得できます。
SCIMトークンを変更する前に、管理者[SAMLグループとロールのマッピング]および[IdPを有効にしてユーザー/グループをプッシュ(SCIM 2.0を使用)]オプションが有効になっていることを確認してください。ユーザーロールには、組織の読み取りおよび更新の権限が割り当てられている必要もあります。
SCIM 2.0の使用と管理者のアセットの権限の詳細については、管理者のヘルプの「ユーザー管理」を参照してください。

SCIMトークンの管理

SCIMトークンを一覧表示、作成、および削除します。

SCIMトークンの一覧表示

scimTokensリソースを使用して、作成したSCIMトークンに関する詳細を要求します。

GET要求

作成したSCIMトークンの一覧を取得するには、次のURIを使用します。
/public/core/v3/scimTokens

GET応答

成功した場合は、作成したそれぞれのSCIMトークンとその有効期限が返されます。
エラーが発生した場合にエラーオブジェクトを返します。

GETの例

作成したSCIMトークンを一覧表示するには、次の要求を使用します。
GET <baseApiUrl>/public/core/v3/scimTokens
Content-type: application/json
Accept: application/json
INFA-SESSION-ID: <SessionId>
応答が成功した場合、以下の例のようになります。
[
{
"id": "im2hLfwsRCvl6WG64Geqi0",
"value": "8fiXOaFR**************",
"expiry": "2025-04-28T21:05:31.000Z",
"status": "active"
}
]

SCIMトークンの作成

scimTokensリソースを使用してSCIMトークンを作成します。すでに2つのトークンがある場合は、1つまたは両方のトークンの有効期限が切れている場合でも、新しいトークンを作成する前に1つのトークンを削除する必要があります。

POST要求

SCIMトークンを作成するには、次のURIを使用します。
/public/core/v3/scimTokens

POST要求の例

トークンを作成する場合、要求は次の例のようになります。
POST <baseApiUrl>/public/core/v3/scimTokens
Content-type: application/json
Accept: application/json
INFA-SESSION-ID: <SessionId>

POST応答

作成したトークンのトークン応答オブジェクトを返します。
エラーが発生した場合はエラーオブジェクトを返します。
応答が成功した場合、以下の例のようになります。
{
"id": "hTc5rzwEFKMh761VofJoG1",
"value": "k7UxoAAAACMAAAACAQAAAAEBAgAAAAyufel1d7nvOzJh5khiVmxxXrnYJl1iR23aBQtVPKPLTiB0qqLCp-davEg50diXElP4-Q==0s3URI0up6Ebu4sLzgtSGC",
"expiry": "2025-05-06T04:54:53.594Z",
"status": "active"
}

SCIMトークンの削除

scimTokensリソースを使用して、SCIMトークンを削除します。
SCIMトークンを削除するには、次のURIを使用してDELETE要求を送信します。
/public/core/v3/scimTokens/<token_id>
成功した応答は204応答コードを返します。エラーが発生した場合は、エラーオブジェクトが返されます。

SCIM管理対象ユーザーの詳細の取得

SCIM管理対象ユーザーのユーザー名に基づいて詳細を取得します。

GET要求

SCIM管理対象ユーザーの詳細を取得するには、次のURIを使用します。
/scim-service/Users?filter=userName eq \"<user name>\"
次の表に、要求ヘッダーを示します。
要求ヘッダー
説明
Content-Type
要求本文のメディアタイプ。application/scim+jsonを使用します。
認証
要求に対して認証するためのSCIMトークン。
次の表に、要求本文内のオプションのフィールドを示します。
フィールド
タイプ
説明
startIndex
Integer
1始まりのインデックス処理を使用して返す、最初の結果のインデックス。
count
整数
返すユーザーの数。
sortOrder
文字列
結果をソートする順序。昇順の場合は"asc"、降順の場合は"desc"を使用します。
schemas
String配列
ユーザータイプごとのスキーマURIのリスト。

GET応答

成功した場合、SCIM管理対象ユーザーの詳細を返します。

GETの例

次のサンプル要求では、SCIM管理対象ユーザーの詳細を取得します。
GET <serverUrl>/scim-service/Users?filter=userName eq \"scim_user\"
Content-Type: application/scim+json
Authorization: <SCIM token>

{
"startIndex": 1,
"count": 1000,
"sortOrder": "asc",
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
]
}
応答が成功した場合、以下の例のようになります。
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"totalResults": 1,
"itemsPerPage": 1,
"startIndex": 1,
"Resources": [
{
"id": "0123abcd4567efgh8901ij",
"externalId": "scim_user",
"userName": "scim_user@informatica.onmicrosoft.com",
"displayName": "scim_user",
"title": "Software Engineer",
"active": true,
"emails": [
{
"value": "scim_user@informatica.onmicrosoft.com",
"type": "work",
"primary": true
}
],
"phoneNumbers": [
{
"value": "123456789",
"type": "work",
"primary": true
}
],
"addresses": [
{
"locality": "Austin",
"country": "US",
"type": "work",
"primary": true
}
],
"schemas": [
"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:enterprise:2.0:User": {
"department": "Software Development"
},
"meta": {
"resourceType": "User",
"created": "2025-01-15T13:22:56.000Z",
"lastModified": "2025-01-25T22:06:24.000Z",
"location": "http://dm-em.informaticacloud.com:443/scim-service/Users/0123abcd4567efgh8901ij"
}
}
]
}

SCIM管理対象グループの取得

SCIM管理対象グループの詳細を取得します。

GET要求

SCIM管理対象グループの詳細を取得するには、次のURIを使用します。
/scim-service/Groups
次の表に、要求ヘッダーを示します。
ヘッダー
説明
Content-Type
要求本文のメディアタイプ。application/scim+jsonを使用します。
認証
要求に対して認証するためのSCIMトークン。
次の表に、要求本文内のオプションのフィールドを示します。
フィールド
タイプ
説明
startIndex
整数
1始まりのインデックス処理を使用して返す、最初の結果のインデックス。
count
整数
返すグループの数。
sortOrder
文字列
結果をソートする順序。昇順の場合は"asc"、降順の場合は"desc"を使用します。
schemas
String配列
ユーザータイプごとのスキーマURIのリスト。

GET応答

成功した場合、SCIM管理対象グループを返します。

GETの例

次のサンプル要求では、SCIM管理対象グループの詳細を取得します。
GET <serverUrl>/scim-service/Groups
Content-Type: application/scim+json
Authorization: <SCIM token>

{
"startIndex": 1,
"count": 1000,
"sortOrder": "asc",
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
]
}
応答が成功した場合、以下の例のようになります。
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"totalResults": 2,
"itemsPerPage": 2,
"startIndex": 1,
"Resources": [
{
"id": "1234efgh5678ijkl9012mn",
"externalId": "ee622900-a8cb-48e3-894a-81009876b9b7",
"displayName": "IDMC Users",
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group"
],
"meta": {
"resourceType": "Group",
"created": "2024-03-15T15:51:13.000Z",
"lastModified": "2024-09-09T15:55:37.000Z",
"location": "http://dm-em.informaticacloud.com:443/scim-service/Groups/1234efgh5678ijkl9012mn"
}
},
{
"id": "4567mnop7890qrst2345uv",
"externalId": "1eb94628-9e9c-4b4d-ad3f-a36d8586ab87",
"displayName": "GroupTwo",
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group"
],
"meta": {
"resourceType": "Group",
"created": "2024-11-29T09:56:11.000Z",
"lastModified": "2025-01-25T18:36:57.000Z",
"location": "http://dm-em.informaticacloud.com:443/scim-service/Groups/4567mnop7890qrst2345uv"
}
}
]
}