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

ユーザー

usersリソースを使用してInformatica Intelligent Cloud Servicesユーザー詳細の要求、ユーザーの作成、ロールとユーザーグループの割り当ての更新、およびユーザーの削除を行います。
注: このリソースは、動的レート制限を使用します。システムで大量の要求またはサイズが発生すると、応答が遅くなったり、「要求が多すぎます」というエラーメッセージが表示されて失敗したりすることがあります。
usersリソースをuserGroupsおよびrolesリソースとともに使用して、Informatica Intelligent Cloud Servicesのタスクおよびアセットのユーザー権限を管理します。ユーザーとグループは割り当てられているロールに基づいて、タスクを実行し、アセットにアクセスする事ができます。
userGroupsおよびroles REST APIリソースの詳細は、次のトピックを参照してください。
users、user groupsおよびrolesの全般的な情報については、Administratorのヘルプを参照してください。

ユーザーの詳細の取得

usersリソースを使用して、Informatica Intelligent Cloud Servicesユーザーの詳細を要求します。組織内のすべてのユーザーの詳細、または特定のユーザーの詳細を要求できます。

GET要求

ユーザーの詳細を取得するには、次のURIを使用します。
/public/core/v3/users
特定のユーザーの詳細を取得するには、次のクエリパラメータをURIに追加する事ができます。
パラメータ
タイプ
説明
q
文字列
クエリフィルタ。次のいずれかのフィールドを使用してフィルタできます。
  • - userId。ユーザーの一意のID。
  • - userName。Informatica Intelligent Cloud Servicesのユーザー名。
limit
Int
返すユーザーの最大数。
最大は200です。デフォルトは100です。
skip
Int
結果のリストのオフセットの量。
デフォルトは0です。
例えば、ユーザーのIDを基にして特定のユーザーの詳細を取得するには、次の要求を使用できます。
/public/core/v3/users?q=userId==5N9JGth6pRYfOGjGKv3Q2D &limit=1 &skip=0

GET応答

正常に実行された場合は、各ユーザーの次の情報を返します。
フィールド
タイプ
説明
id
文字列
ユーザーID。
orgId
文字列
ユーザーが属する組織のID。
createdBy
文字列
ユーザーアカウントを作成したユーザー。
updatedBy
文字列
ユーザーアカウントを最後に更新したユーザー。
createTime
文字列
ユーザーを作成した日時。
updateTime
文字列
ユーザーが最後に更新された日時。
userName
文字列
ユーザーアカウントのユーザー名。
firstName
文字列
ユーザーアカウントの名。
lastName
文字列
ユーザーアカウントの姓。
description
文字列
ユーザーの説明。
title
文字列
ユーザーの役職。
phone
文字列
ユーザーの電話番号。
email
文字列
ユーザーのメールアドレス。
state
文字列
ユーザーアカウントの状態。次のいずれかの値を返します。
  • - アクティブ。ユーザーアカウントが存在し、ユーザーはアカウントをアクティブ化済みです。
  • - プロビジョニング済み。ユーザーアカウントは存在しますが、ユーザーはアカウントをアクティブ化していません。
  • - 利用不可状態。ログイン試行の最大数を超えたため、ユーザーアカウントが無効になっています。
注: ユーザーのパスワードの有効期限が切れている場合、値はNULLになります。
timeZoneId
文字列
ユーザーのタイムゾーン。
詳細については、タイムゾーンのコードを参照してください。
maxLoginAttempts
Int
アカウントがロックされるまでのログイン試行の回数。
authentication
文字列
ユーザーがシングルサインイン(SAML)を使用してInformatica Intelligent Cloud Servicesにアクセスするかどうか。
次のいずれかの値を返します。
  • - 0。ネイティブ。
  • - 1。SAML。
forcePasswordChange
Boolean
初回ログイン後、ユーザーがパスワードをリセットする必要があるかどうか。
lastLoginTime
文字列
ユーザーが最後にログインした日時。
lastLoginMode
文字列
ユーザーがREST API呼び出しを介してログインしたかUIを介してログインしたかを示します。
roles
配列
ユーザーアカウントに割り当てられたロール。
id
文字列
rolesオブジェクトに含まれます。
ロールID。
roleName
文字列
rolesオブジェクトに含まれます。
ロール名。
description
文字列
rolesオブジェクトに含まれます。
ロールの説明。
displayName
String
rolesオブジェクトに含まれます。
ユーザーインタフェースに表示されるロール名。
displayDescription
String
rolesオブジェクトに含まれます。
ユーザーインタフェースに表示されるロールの説明。
groups
配列
ユーザーアカウントがメンバーになっているグループ。
id
文字列
groupsオブジェクトに含まれます。
ユーザーグループID。
userGroupName
文字列
groupsオブジェクトに含まれます。
ユーザーグループ名。
description
文字列
groupsオブジェクトに含まれます。
ユーザーグループの説明。

GET応答の例

成功した場合、次の例のような応答を受信します。
[
{
"id": "5N9JGth6pRYfOGjGKv3Q2D",
"orgId": "cPYWk02I4aBeuLEvYRtaMS",
"createdBy": "ma",
"updatedBy": "a@abc.com",
"createTime": "2019-03-06T22:04:00.000Z",
"updateTime": "2019-03-18T22:34:53.000Z",
"userName": "a@abc.com",
"firstName": "a",
"lastName": "jones",
"description": "",
"title": "dev",
"phone": "1112221111",
"email": "a@abc.com",
"state": "Enabled",
"timeZoneId": "America/Los_Angeles",
"maxLoginAttempts": "10",
"authentication": "Native",
"forcePasswordChange": false,
"lastLoginTime": "2020-07-31T21:50:10Z",
"lastLoginMode": "API",
"roles": [
{
"id": "9c2XrdpAz80hg29yXDBPEN",
"roleName": "Data Preview",
"description": "Role to preview data"
"displayName": "Data Preview",
"displayDescription": "Role to preview data"
},
{
"id": "1VfnsgZiCT1fi25VAupQg1",
"roleName": "Designer",
"description": "Role for creating assets, ... and runtime environments. Has access to the Application Integration Console."
"displayName": "Designer",
"displayDescription": "Role for creating assets, ... and runtime environments. Has access to the Application Integration Console."
}
],
"groups": [
{
"id": "a6x85hoMvH2kWUIlcIRBEh",
"userGroupName": "group_a",
"description": ""
}
]
},
{
"id": "aNJWtppg613c1YbXvRRHcV",
"orgId": "cPYWk02I4aBeuLEvYRtaMS",
"createdBy": "a@abc.com",
"updatedBy": "a@abc.com",
"createTime": "2019-03-13T20:15:58.000Z",
"updateTime": "2019-03-13T20:15:58.000Z",
"userName": "b@abc.com",
"firstName": "b",
"lastName": "smith",
"description": "",
"title": "cs",
"phone": "1112223333",
"email": "b@abc.com",
"state": "Provisioned",
"timeZoneId": "America/Los_Angeles",
"maxLoginAttempts": "10",
"authentication": "Native",
"forcePasswordChange": false,
"lastLoginTime": "2020-07-31T21:50:10Z",
"lastLoginMode": "API",
"roles": [
{
"id": "9c2XrdpAz80hg29yXDBPEN",
"roleName": "Data Preview",
"description": "Role to preview data"
"displayName": "Data Preview",
"displayDescription": "Role to preview data"
}
],
"groups": [
{
"id": "a6x85hoMvH2kWUIlcIRBEh",
"userGroupName": "group_a",
"description": ""
}
]
}
]

ユーザーの作成

管理者特権を持っている場合、usersリソースを使用してユーザーを作成できます。

POST要求

ユーザーを作成するには、次のURIを使用してPOST要求を送信します。
/public/core/v3/users
注: ユーザー、ユーザーグループ、結合されたロールの数は、1つの組織で1000を超える事は出来ません。
以下の情報を含めます。
フィールド
タイプ
必須
説明
name
String
Informatica Intelligent Cloud Servicesのユーザー名。有効な電子メールアドレスであるか、英数字、ハイフン、アンダースコア、ピリオド、アポストロフィのみを含める必要があります。
最大長は255文字です。
firstName
String
ユーザーアカウントの名。
lastName
String
ユーザーアカウントの姓。
password
String
-
Informatica Intelligent Cloud Servicesのパスワード。
パスワードが空の場合、ユーザーはアクティベーション電子メールを受け取ります。
最大長は255文字です。
description
文字列
-
ユーザーの説明。
email
String
ユーザーのメールアドレス。
title
文字列
-
ユーザーの役職。
phone
文字列
-
ユーザーの電話番号。
forcePasswordChange
Boolean
-
初回ログイン後、ユーザーがパスワードをリセットする必要があるかどうかを決定します。
maxLoginAttempts
Int
-
アカウントがロックされるまでのログイン試行の回数。
authentication
Int
-
ユーザーがシングルサインイン(SAML)を使用してInformatica Intelligent Cloud Servicesにアクセスするかどうかを決定します。
以下の値を使用します。
  • - 0。ネイティブ。
  • - 1。SAML。
aliasName
文字列
認証が0でない場合は必須。
サードパーティーシステムでのユーザーIDまたはユーザー名。
roles
配列
グループIDが含まれていない場合は必須。
ユーザーに割り当てるロールのID。
groups
配列
ロールIDが含まれていない場合は必須。
ユーザーに割り当てるユーザーグループのID。

POST応答

成功した場合、usersオブジェクトと、POST要求に含めた詳細が返されます。

POSTの例

ユーザーを作成するには、次の例のような要求を送信します。
POST <baseApiUrl>/public/core/v3/users
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
"name" : "c@abc.com",
"firstName" : "c",
"lastName" : "smith",
"email" : "c@abc.com",
"authentication" : 0,
"roles" : ["5IPgtye09EbiWqz5XXuzwC", "9gedBDoYQoQibNMohf5KCh"],
"groups" : ["a6x85hoMvH2kWUIlcIRBEh"]
}
次の例のような応答を受信します。
{
"id": "9EcgvBYZ9GGflOYr98GzOH",
"orgId": "cPYWk02I4aBeuLEvYRtaMS",
"createdBy": "a@abc.com",
"updatedBy": "a@abc.com",
"createTime": "2020-08-20T18:29:19.987Z",
"updateTime": "2020-08-20T18:29:20.653Z",
"userName": "c@abc.com",
"firstName": "c",
"lastName": "smith",
"description": null,
"title": "dev",
"phone": null,
"email": "c@abc.com",
"state": "Provisioned",
"timeZoneId": "America/Los_Angeles",
"maxLoginAttempts": "10",
"authentication": "Native",
"forcePasswordChange": false,
"lastLoginTime": null,
"lastLoginMode": "None",
"roles": [
{
"id": "5IPgtye09EbiWqz5XXuzwC",
"roleName": "test",
"description": ""
},
{
"id": "9gedBDoYQoQibNMohf5KCh",
"roleName": "Admin",
"description": "Role for performing administrative tasks for an organization. Has full access to all licensed services."
}
],
"groups": [
{
"id": "a6x85hoMvH2kWUIlcIRBEh",
"userGroupName": "group_a",
"description": ""
}
]
}

ロールの割り当ての更新

ユーザーに対するロールの割り当てを追加または削除できます。
組織でSAMLシングルサインオンの[SAMLグループとロールのマッピング]オプションが有効になっている場合、ユーザーのロール割り当てを更新することはできません。詳細については、Administratorヘルプの「ユーザー管理」を参照してください。

ロールの割り当て

ユーザーにロールを割り当てるには、次のURIのいずれかを使用してPUT要求を送信します。
/public/core/v3/users/<user ID>/addRoles
/public/core/v3/users/name/<user name>/addRoles
ユーザーに割り当てるロールの配列を含めます。
例えば、管理者とビジネスマネージャーのロールをユーザーに割り当てるには、次の要求を使用できます。
PUT <baseApiUrl>/public/core/v3/users/cPYWk02I4aBeuLEvYRtaMS/addRoles
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
"roles" : ["Admin", "Business Manager"]
}
rolesリソースを使用して、割り当てることができるロールのリストを取得できます。詳細については、ロールを参照してください。
成功した場合は成功コード、エラーが発生した場合はエラーオブジェクトが返されます。

ロールの削除

ユーザーからロールの割り当てを削除するには、次のURIのいずれかを使用してPUT要求を送信します。
/public/core/v3/users/<user ID>/removeRoles
/public/core/v3/users/name/<user name>/removeRoles
割り当てを解除するロールの配列を含めます。
例えば、ユーザーからデザイナのロールの割り当てを削除するには、次の要求を使用できます。
PUT <baseApiUrl>/public/core/v3/users/cPYWk02I4aBeuLEvYRtaMS/removeRoles
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
"roles" : "Designer"
}

ユーザーグループの割り当ての更新

ユーザーのユーザーグループ割り当てを追加または削除できます。
組織でSAMLシングルサインオンの[SAMLグループとロールのマッピング]オプションが有効になっている場合、ユーザーのユーザーグループ割り当てを更新することはできません。詳細については、Administratorヘルプの「ユーザー管理」を参照してください。

ユーザーグループの割り当て

ユーザーグループをユーザーに割り当てるには、次のURIのいずれかを使用してPUT要求を送信します。
/public/core/v3/users/<user ID>/addGroups
/public/core/v3/users/name/<user name>/addGroups
ユーザーに割り当てるユーザーグループの配列を含めます。
例えば、Workflow ManagerとMDM管理者のユーザーグループをユーザーに割り当てるには、次の要求を使用できます。
PUT <baseApiUrl>/public/core/v3/users/cPYWk02I4aBeuLEvYRtaMS/addGroups
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
"groups" : ["Workflow Manager", "MDM Admin"]
}
userGroupsリソースを使用して、割り当てることができるユーザーグループのリストを取得できます。詳細については、ユーザーグループを参照してください。
成功した場合は成功コード、エラーが発生した場合はエラーオブジェクトが返されます。

ユーザーグループの割り当ての削除

ユーザーグループの割り当てを削除するには、次のURIのいずれかを使用してPUT要求を送信します。
/public/core/v3/users/<user ID>/removeGroups
/public/core/v3/users/name/<user name>/removeGroups
ユーザーから削除するユーザーグループ割り当ての配列を含めます。
例えば、MDM管理者ユーザーグループの割り当てを削除するには、次の要求を使用できます。
PUT <baseApiUrl>/public/core/v3/users/name/LarryR/removeGroups
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
"groups" : "MDM Admin"
}

ユーザーの削除

管理者特権を持っている場合、usersリソースを使用してユーザーを削除できます。

DELETE要求

ユーザーアカウントを削除するには、次のURIを使用します。
/public/core/v3/users/<userId>
例えば、次の例のような要求を送信します。
DELETE <baseApiUrl>/public/core/v3/users/5N9JGth6pRYfOGdGKv3Q2D