概要

Informatica Intelligent Cloud Services (IICS) ではREST APIを使用して組織の情報にアクセスしたり、アセットやオブジェクトの作成・更新・削除などを行ったりできます。

 

このブログではIICSユーザーの参照と作成を行うREST APIの使い方を解説します。

 

これらのREST APIを実行する前にログインを行う必要があります。REST APIでログインおよびログインを行う方法はこちらの記事を参考にしてください。

 

ユーザーを作成する際にユーザーグループやロールのIDを指定する必要があります。これらの値を取得する方法はこちらの記事を参考にしてください。

 

REST APIでユーザーを作成するには "Number of user-management create requests" ライセンスが必要となります。

 

 

APIの使い方

  • ユーザーの参照

    • URL

      <BaseURL>/public/core/v3/users

      • BaseURL
        • ログインのREST APIの応答で返されたベースURLを設定します。
    • メソッド

      GET

    • ヘッダー

      Content-Type: application/json

      Accept: application/json

      INFA-SESSION-ID: <SessionID>

      • SessionID
        • ログインのREST APIの応答で返されたセッションIDを設定します。
    • クエリパラメータ

      ?q=userName=="ユーザー名"&limit=最大数&skip=オフセット

      • ユーザー名 (オプション)

        • クエリフィルタ (userNameの代わりにuserIdを使用してユーザーIDでのフィルタも可)

      • 最大数 (オプション)

        • 返されるユーザーグループの最大数

      • オフセット (オプション)

        • 結果のリストの最大数

    • レスポンス (正常時)

      [

          {

              "id": "ユーザーID",

              "orgId": "組織ID",

              "createdBy": "作成したユーザー",

              "updatedBy": "最後に更新したユーザー",

              "createTime": "作成日時",

              "updateTime": "更新日時",

              "userName": "ユーザー名",

              "firstName": "ユーザーの名",

              "lastName": "ユーザーの姓",

              "description": "ユーザーの説明",

              "title": "ユーザーの役職",

              "phone": "ユーザ-の電話番号",

              "email": "ユーザーのメールアドレス",

              "state": "ユーザーアカウントの状態",

              "timeZoneId": "ユーザーのタイムゾーン",

              "maxLoginAttempts": "アカウントがロックされるまでの試行回数",

              "authentication": "サインインの方法",

              "forcePasswordChange": 初回ログイン後にパスワードをリセットする必要があるか,

              "lastLoginTime": "最後にログインした日時",

              "lastLoginMode": "最後にログインしたモード",

              "roles": [ユーザーアカウントに割り当てられたロール],

              "groups": [ユーザーグループに割り当てられたロール]

          }

      ]

      • ユーザーID
        • ユーザーの削除時などに、このIDを設定します。

 

  • ユーザーの作成

    • URL

      <BaseURL>/public/core/v3/users

      • BaseURL
        • ログインのREST APIの応答で返されたベースURLを設定します。
    • メソッド

      POST

    • ヘッダー

      Content-Type: application/json

      Accept: application/json

      INFA-SESSION-ID: <SessionID>

      • SessionID
        • ログインのREST APIの応答で返されたセッションIDを設定します。
    • リクエストボディ

      {

          "name" : "ユーザー名",

          "firstName" : "ユーザーの名",

          "lastName" : "ユーザーの姓",

          "password" : "パスワード",

          "description": "ユーザーの説明",

          "email" : "ユーザーのメールアドレス",

          "title": "ユーザーの役職",

          "phone": "ユーザーの電話番号",

          "maxLoginAttempts": 初回ログイン後にパスワードをリセットする必要があるか,

          "roles": ["ユーザーアカウントに割り当てられたロール"],

          "groups" : ["ユーザーアカウントがメンバーになっているグループ"]

      }

      • ユーザー名
        • IICSにログインする際のユーザー名
      • パスワード
        • パスワードが空の場合、ユーザーはアクティベーションのメールを受け取ります
      • ロール/グループ
        • ユーザーに割り当てるロールとはユーザーグループのいずれか、あるいは両方を指定します
        • 複数の割り当てる場合はカンマ(,)で区切って記述します
    • レスポンス (正常時)

      (ユーザーの参照のREST APIと同じレスポンス)

 

Postmanのサンプル

このブログで紹介したREST APIをPostmanのコレクション(Collection)としてダウンロードできます。

  • IICS REST API: ログインとログアウト」で使用したコレクションおよび環境(Environment)とあわせて利用してください。
    • ログイン時の応答で返される「ベースURL」と「セッションID」を環境変数として使用しています。
  • ユーザー参照のクエリパラメータはログイン時のユーザー名を指定しています。
  • ユーザー作成のリクエストボディは任意の値を指定してください。

 

※これらは動作検証を目的としたサンプルとしてのみご利用いただけます。すべての環境で動作することの確認や保証は行っておりません。またインフォマティカ社によるサポートも行っていません。