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

組織

REST APIを使用して、Informatica Intelligent Cloud Services組織または関連するサブ組織の詳細の要求、組織または関連するサブ組織の更新、サブ組織の削除、あるいはサブ組織の作成を行うことができます。

組織管理

このリソースを使用して、Informatica Intelligent Cloud Services組織または関連するサブ組織の詳細を要求します。このリソースを使用して、組織または関連するサブ組織を更新することができます。サブ組織を削除することもできます。

GET要求

組織の詳細を要求するには、次のURIを使用します。
/api/v2/org
組織に関連するサブ組織の詳細を要求するために、URIにサブ組織IDまたはサブ組織名を含めることができます。次のいずれかのURIを使用します。
/api/v2/org/<sub-organization ID>
/api/v2/org/name/<sub-organization name>
URIに組織名を使用し、組織名にスペースが含まれる場合、スペースを%20に置き換えます。以下に例を示します。
/api/v2/org/name/my%20suborg

GET応答

組織の詳細を要求するときに、Informatica Intelligent Cloud Servicesはリスト形式でorgオブジェクトを返します。
組織が組織階層の親組織の場合、orgオブジェクトにすべてのサブ組織のIDと名前が含まれます。
エラーが発生した場合にエラーオブジェクトを返します。
orgオブジェクトには次の属性が含まれます。
フィールド
タイプ
説明
id
String
組織ID。
orgId
String
組織ID。
name
String
組織名。
description
String
組織の説明。
createTime
Date/Time
組織が作成された日時。
updateTime
Date/Time
組織の最終更新時刻。
createdBy
String
組織を作成したユーザー。
updatedBy
String
組織を更新した最後のユーザー。
parentOrgId
String
親組織の組織ID。
組織がスタンドアロンまたは親の組織である場合、0を返します。
address1
String
組織の住所。
address2
String
組織の住所の追加情報。
address3
String
組織の住所の追加情報。
city
String
組織の拠点がある市区町村。
state
String
組織の拠点がある都道府県。州コードを返します。
詳細については、州コードを参照してください。
zipcode
String
組織の拠点がある地域の郵便番号。
timezone
String
組織のタイムゾーン。詳細については、タイムゾーンのコードを参照してください。
country
String
組織の拠点がある国。国コードを返します。
詳細については、国コードを参照してください。
employees
String
組織の従業員の範囲。
offerCode
String
Informatica Intelligent Cloud Servicesパートナーに割り当てられたオファーコード。
successEmails
String
正常に完了したタスクの通知を受信するための電子メールアドレス。
warningEmails
String
エラーで完了したタスクの通知を受信するための電子メールアドレス。
errorEmails
String
完了に失敗したタスクの通知を受信するための電子メールアドレス。
campaignCode
String
キャンペーンコード。
atlasProjectId
String
AtlasプロジェクトID。
zuoraAccountId
String
ZuoraアカウントID。
spiUrl
String
このフィールドは適用されなくなり、非推奨になりました。
devOrg
Boolean
組織が開発組織であることを示します。
開発組織の場合は1を返します。プロダクション組織の場合は0を返します。
maxLogRows
Int
アクティビティログに保持する最大行数。
minPasswordLength
Int
ユーザーアカウントパスワードの最小文字数。
minPasswordCharMix
Int
各パスワードには文字を混在させる必要があります。
パスワードには、次の文字セットを混在させることができます: 小文字、大文字、数字、および特殊文字。
次のいずれかの値を返します。
  • - 1. 少なくとも1つの文字セットが含まれます。
  • - 2. 少なくとも2つの文字セットが含まれます。
  • - 3. 少なくとも3つの文字セットが含まれます。
  • - 4. 4つすべての文字セットが含まれます。
passwordReuseInDays
Int
前のパスワードを再度使用できるまでの日数。
値0はパスワードを常に再利用できることを意味します。
passwordExpirationInDays
Int
パスワードの有効期限までの日数。
値0はパスワードの有効期限がないことを意味します。
subOrgLimit
Int
許可されたサブ組織数。限界がカスタマイズされている場合、REST APIはカスタム制限を返します。カスタマイズされていない場合、REST APIはエディションに関連付けられた制限を返します。
restApiSessionLimit
Int
許可されたconcurrent REST APIの同時セッションの数。限界がカスタマイズされている場合、REST APIはカスタム制限を返します。カスタマイズされていない場合、REST APIはエディションに関連付けられた制限を返します。
parentOrgId
String
親組織の組織ID。
0は、組織がスタンドアロンまたは親の組織であることを示します。
jobExecUserProfile
String
コンタクト検証タスクを実行するために設定されたInformatica Intelligent Cloud Servicesユーザーアカウント。
orgUUID
String
組織の一意のID。
subOrgs
各サブ組織に情報を含むオブジェクト。
id
String
subOrgsオブジェクトに含まれます。
サブ組織のID。
name
String
subOrgsオブジェクトに含まれます。
サブ組織の名前。

POST要求

REST APIセッションを開始したユーザーが、管理者ロールを所有し、更新する組織または親組織のいずれかに属している場合、Informatica Intelligent Cloud Services組織を更新できます。
組織に適切なライセンスがあり、REST APIセッションを開始したユーザーが親組織で管理者ロールを持つ場合、サブ組織を更新できます。
親組織に関連するサブ組織の詳細を更新するには、次のURIの組織IDを使用します。組織の詳細を更新するには、オプションのIDを省略します。
/api/v2/org/<id>
注: REST APIを介して組織を更新するときに、アクションは完全に更新されます。フィールドが要求に含まれていない場合、値はデフォルトにリセットします。
組織ID、オファーコード、または組織で作成された組織管理者のユーザーアカウントは更新できません。
このURIで、orgオブジェクトの次の属性を使用できます。
フィールド
タイプ
必須
説明
name
String
組織名。
address
String
組織の住所。
address2
String
組織の住所の追加情報。
address3
String
組織の住所の追加情報。
city
String
組織の拠点がある市区町村。
state
String
国がUSの場合に必須。
組織の拠点がある都道府県。適切な州コードを使用します。
国がUSに設定される場合に必須。
詳細については、付録A、州コードを参照してください。
zipcode
String
国がUSの場合に必須。
組織の拠点がある地域の郵便番号。
国がUSに設定される場合に必須。
country
String
組織の拠点がある国。適切な国コードを使用します。
詳細については、付録A、国コードを参照してください。
timezone
String
組織のタイムゾーン。タイムゾーンは夏時間を使用します。
詳細については、付録A、タイムゾーンのコードを参照してください。
description
String
組織の説明。最大長は255文字です。
successEmails
String
ジョブが正常に完了したことを通知するためのデフォルトの電子メールアドレス。
warningEmails
String
ジョブ完了について警告するためのデフォルトの電子メールアドレス。
errorEmails
String
ジョブ失敗について通知するためのデフォルトの電子メールアドレス。
employees
String
組織の従業員の範囲。次の範囲のいずれかを使用します。
  • - "0_10"
  • - "11_25"
  • - "26_50"
  • - "51_100"
  • - "101_500"
  • - "501_1000"
  • - "1001_5000"
  • - "5001_"
offerCode
String
Informatica Intelligent Cloud Servicesパートナーに割り当てられたオファーコード。
passwordReuseInDays
Int
前のパスワードを再度使用できるまでの日数。
最大日数は730(2年)です。
値0はパスワードを常に再利用できることを意味します。
passwordExpirationInDays
Int
パスワードの有効期限までの日数。
最大日数は180です。
値0はパスワードの有効期限がないことを意味します。

POST応答

成功した場合、作成または更新した組織のorg要求オブジェクトを返します。
エラーが発生した場合にエラーオブジェクトを返します。

DELETE要求

REST APIセッションを開始したユーザーが、管理者ロールを所有し、親組織に属している場合、Informatica Intelligent Cloud Servicesサブ組織を削除できます。
Informatica Intelligent Cloud Services組織を削除するには、次のURIで組織IDを使用します。
/api/v2/org/<id>

DELETE応答

要求に成功した場合に200の応答コードを返します。
エラーが発生した場合にエラーオブジェクトを返します。

POSTの例

ID 02340000でサブ組織を更新するために、次の要求を使用することができます。
POST <serverUrl>/api/v2/org/02340000 HTTP/<HTTP version>
Content-Type: application/xml
Accept: application/xml
icSessionId: <icSessionId>

<org>
<name>Dev Org</name>
<address1>333 Main Street</address1>
<city>City</city>
<state>MD</state>
<zipcode>90001</zipcode>
<country>US</country>
<timezone>America/Chicago</timezone>
</org>
成功した要求は、更新したサブ組織のorg要求オブジェクトを返します。

サブ組織の作成

このリソースを使用して、Informatica Intelligent Cloud Servicesサブ組織を作成します。Informatica Intelligent Cloud Servicesパートナーのみの場合。
組織に適切なライセンスがあり、REST APIセッションを開始したユーザーが親組織で管理者ロールを持つ場合、Informatica Intelligent Cloud Servicesサブ組織を作成できます。

register POST要求

Informatica Intelligent Cloud Servicesサブ組織を作成するには、次のURIを使用します。
/api/v2/user/register
要求ヘッダーでログイン応答からのセッションIDを使用します。ベースURLとしてログイン応答からのserverUrlを使用します。
登録オブジェクトでは次の属性を使用できます。
フィールド
タイプ
必須
説明
org
Informatica Intelligent Cloud Services組織を定義する属性。
offerCode
String
orgオブジェクトに含めます。
Informatica Intelligent Cloud Servicesパートナーに割り当てられたオファーコード。
name
String
orgオブジェクトに含めます。
新しいInformatica Intelligent Cloud Services組織の名前。
address1
String
orgオブジェクトに含めます。
組織が存在する住所。
address2
String
orgオブジェクトに含めます。
組織の住所の追加情報。
address3
String
orgオブジェクトに含めます。
組織の住所の追加情報。
city
String
orgオブジェクトに含めます。
組織が存在する市区町村。
state
String
orgオブジェクトに含めます。
組織が存在する州。適切な州コードを使用します。
米国の場合は必須です。
詳細については、付録A、州コードを参照してください。
zipcode
String
orgオブジェクトに含めます。
組織が存在する郵便番号。
country
String
orgオブジェクトに含めます。
組織が存在する国。適切な国コードを使用します。
詳細については、付録A、国コードを参照してください。
timezone
String
orgオブジェクトに含めます。
Informatica Intelligent Cloud Servicesは、デフォルトのタイムゾーンとしてAmerica/Los_Angelesを使用します。サブ組織を作成した後、orgリソースを使用してタイムゾーンを変更するか、管理者でタイムゾーンを変更できます。
employees
String
orgオブジェクトに含めます。
組織の従業員数。次の範囲のいずれかを使用します。
  • - "0_10"
  • - "11_25"
  • - "26_50"
  • - "51_100"
  • - "101_500"
  • - "501_1000"
  • - "1001_5000"
  • - "5001_"
user
組織の管理者ユーザーアカウントを定義する属性。
name
String
ユーザーオブジェクトに含めます。
組織の管理者アカウントの電子メールアドレス。
password
String
ユーザーオブジェクトに含めます。
組織の管理者アカウントのパスワード。
firstName
String
ユーザーオブジェクトに含めます。
組織の管理者の名。
lastName
String
ユーザーオブジェクトに含めます。
組織の管理者の姓。
title
String
ユーザーオブジェクトに含めます。
組織の管理者の役職。
phone
String
ユーザーオブジェクトに含めます。
組織の管理者の電話番号。
emails
String
ユーザーオブジェクトに含めます。
Informatica Intelligent Cloud Servicesからの通知を受け取るための電子メールアドレス。
timezone
String
ユーザーオブジェクトに含めます。
組織の管理者のタイムゾーン。
Informatica Intelligent Cloud Servicesは、デフォルトのタイムゾーンとしてAmerica/Los_Angelesを使用します。サブ組織を作成した後、orgリソースを使用してタイムゾーンを変更するか、管理者でタイムゾーンを変更できます。
securityQuestion
String
ユーザーオブジェクトに含めます。
セキュリティの質問。次のいずれかのコードを使用してセキュリティの質問を選択します。
  • - SPOUSE_MEETING_CITY
  • - FIRST_JOB_CITY
  • - CHILDHOOD_FRIEND
  • - MOTHER_MAIDEN_NAME
  • - PET_NAME
  • - CHILDHOOD_NICKNAME
  • - CUSTOM_QUESTION:"<question>"
securityAnswer
String
ユーザーオブジェクトに含めます。
セキュリティの質問に対する答え。
forceChangePassword
Boolean
ユーザーオブジェクトに含めます。
初回ログイン後、ユーザーがパスワードをリセットする必要があるかどうかを決定します。次の値が含まれます。
  • - True。ユーザーはパスワードをリセットする必要があります。
  • - False。ユーザーはパスワードをリセットする必要がありません。
optOutOfEmails
Boolean
ユーザーオブジェクトに含めます。
ユーザーがInformaticaからのマーケティング情報の受信を承諾するか否か。TRUEは、ユーザーがマーケティング情報の受信を望まないことを示します。
registrationCode
String
登録コード。
sendEmail
Boolean
登録が完了すると、ユーザーの電子メールアドレスに一時的なログイン情報を含む電子メールを送信します。TRUEを使用し、電子メールを送信します。

POST応答

要求が成功すると、ユーザーオブジェクトを返します。エラーが発生した場合にエラーオブジェクトを返します。
ユーザーオブジェクトには次の属性が含まれます。
フィールド
タイプ
説明
id
String
ユーザーID。
orgId
String
ユーザーが属する組織のID。
22文字。
注: 従来のInformatica Cloudで作成された組織では、6文字の組織IDである可能性があります。
orgUuid
String
組織の一意のID。
name
String
Informatica Intelligent Cloud Servicesのユーザー名。
description
String
ユーザーの説明。
createTime
String
ユーザーアカウントの作成日時。
updateTime
String
ユーザーアカウントの最終作成日時。
createdBy
String
ユーザーアカウントを作成したInformatica Intelligent Cloud Servicesユーザー。
updatedBy
String
ユーザーアカウントを最後に更新したInformatica Intelligent Cloud Servicesユーザー。
sfUsername
String
Salesforceのユーザー名。ユーザーがSalesforceによって認証されるように設定されている場合に含まれます。
password
String
Salesforceのユーザーパスワード。ユーザーがSalesforceによって認証されるように設定されている場合に含まれます。
firstName
String
ユーザーアカウントの名。
lastName
String
ユーザーアカウントの姓。
title
String
ユーザーの役職。
phone
String
ユーザーの電話番号。
securityQuestion
String
セキュリティの質問。次のいずれかのコードを返します。
  • - SPOUSE_MEETING_CITY
  • - FIRST_JOB_CITY
  • - CHILDHOOD_FRIEND
  • - MOTHER_MAIDEN_NAME
  • - PET_NAME
  • - CHILDHOOD_NICKNAME
  • - CUSTOM_QUESTION:"<question>"
securityAnswer
String
セキュリティの質問に対する答え。
roles
ユーザーに割り当てられた各ロールのロールオブジェクトを含むオブジェクト。
name
String
ロールオブジェクトに含まれます。
ロール名。次のいずれかのコードを返します。
  • - サービスコンシューマ
  • - Designer
  • - Admin
description
String
ロールオブジェクトに含まれます。
ロールの説明。
emails
String
ユーザーがアカウントパスワードを変更する際に通知される電子メールアドレス。
timezone
String
ユーザーのタイムゾーン。タイムゾーンは夏時間を使用します。
詳細については、タイムゾーンのコードを参照してください。
serverUrl
String
ユーザーが属する組織のInformatica Intelligent Cloud ServicesのURL。最も正確なバージョン2 REST APIのリソースURIのベースとしてserverUrlを使用します。
spiUrl
String
このフィールドは適用されなくなり、非推奨になりました。
uuId
String
ユーザーの一意のID。
icSessionId
String
バージョン2 REST APIセッションのInformatica Intelligent Cloud ServicesセッションID。最も正確なバージョン2 REST API要求ヘッダーで使用します。
forceChangePassword
Boolean
初回ログイン後、ユーザーがパスワードをリセットする必要があるかどうかを決定します。次の値が含まれます。
  • - True。ユーザーはパスワードをリセットする必要があります。
  • - False。ユーザーはパスワードをリセットする必要がありません。

POSTの例

JSONで組織を登録するには、次の要求を使用できます。
POST <serverUrl>/api/v2/user/register HTTP/<HTTP version>
Content-Type: application/json
Accept: application/json
icSessionId: <SessionId>

{
"@type" : "registration",
"user" : {
"@type" : "user",
"name" : "useremail@company.com",
"emails" : "useremail@company.com",
"firstName" : "firstName",
"lastName" : "lastName",
"title" : "jobTitle",
"phone" : "(0)1234 567 890",
"timezone" : null,
"forceChangePassword" : "true"
"optOutOfEmails" : "true"
},
"org" : {
"@type" : "org",
"offerCode" : "PPC30daytrial",
"campaignCode" : "PPC",
"name" : "myOrg",
"address1" : "1 Main St",
"city" : "Mycity",
"state" : "CA",
"zipcode" : "90210",
"country" : "US",
"employees" : "5001_"
},
"registrationCode" : "ics-standard",
"sendEmail" : true
}
成功した要求は作成されたユーザーオブジェクトを返し、これには作成された組織の組織IDが含まれます。