概要

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

 

このブログではユーザーに割り当てるユーザーグループとユーザーロールを参照するREST APIの使い方を解説します。

 

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

 

APIの使い方

  • ユーザーグループの参照

    • URL

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

      GET

    • ヘッダー

      Content-Type: application/json

      Accept: application/json

      INFA-SESSION-ID: <SessionID>

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

      ?q=userGroupName=="ユーザーグループ名"&limit=最大数&skip=オフセット

      • ユーザーグループ名 (オプション)
        • クエリフィルタ (userGroupNameの代わりにuserGroupIdを使用してユーザーグループIDでのフィルタも可)
      • 最大数
        • 返されるユーザーグループの最大数
      • オフセット
        • 結果のリストの最大数
    • レスポンス (正常時)

      [

          {

              "id": "ユーザーグループID",

              "orgId": "組織ID",

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

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

              "createTime": "作成日",

              "updateTime": "更新日",

              "userGroupName": "ユーザーグループ名",

              "description": "ユーザーグループの説明",

              "roles": [

                  {

                      "id": "ロールID",

                      "roleName": "ロール名",

                      "description": "ロールの説明",

                      "displayName": "ユーザーインターフェースに表示されるロール名",

                      "displayDescription": "ユーザーインタフェースに表示されるロールの説明"

                  }

              ],

              "users": [

                  {

                      "id": "ユーザーのオブジェクトID",

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

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

                  }

              ]

          }

      ]

      • ユーザーグループID
        • ユーザーグループの削除や、ユーザー作成時にユーザーグループを指定する場合、このIDを設定します。

 

  • ユーザーロールの参照

    • URL

      <BaseURL>/public/core/v3/roles

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

      GET

    • ヘッダー

      Content-Type: application/json

      Accept: application/json

      INFA-SESSION-ID: <SessionID>

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

      ?q=roleName=="ロール名"&expand=privilege

      • ロール名 (オプション)
        • クエリフィルタ (roleNameの代わりにroleIdを使用してロールIDでのフィルタも可)
        • ロールに関連する権限も表示する場合は expand=privilege を付与
    • レスポンス (正常時)

      [

          {

              "id": "ロールID",

              "orgId": "組織ID",

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

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

              "createTime": "作成日",

              "updateTime": "更新日",

              "roleName": "ロール名",

              "description": "ロールの説明",

              "displayName": "ユーザーインタフェースに表示されるロール名",

              "displayDescription": "ユーザーインタフェースに表示されるロールの説明",

              "systemRole": システムロールかカスタムロールのフラグ,

              "status": "ロールを使用するための組織のライセンスが有効/無効のフラグ"

          },

          {
             ・・・
          }

      ]

      • ロールID
        • ユーザーロールの削除や、ユーザー作成時にユーザーロールを指定する場合、このIDを設定します。

 

URLでのユーザーグループIDとロールIDの確認

ユーザーグループIDおよびロールIDはURLからも確認することができます。

それぞれのアセットを表示し、URLの最後に表示される値がIDになります。

例: 赤字がユーザーグループIDになります

https://na1.dm-us.informaticacloud.com/cloudUI/products/administer/main/userGroupsAsset/hEDHixxxxxxxxxxxxjCs6C

 

Postmanのサンプル

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

  • IICS REST API: ログインとログアウト」で使用したコレクションおよび環境(Environment)とあわせて利用してください。
    • ログイン時の応答で返される「ベースURL」と「セッションID」を環境変数として使用しています。

 

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