ユーザ Web サービス

API は、ユーザ アカウントを管理するためのユーザ Web サービスを提供します。 以下のタスクを実行できます。
capm380
API は、ユーザ アカウントを管理するためのユーザ Web サービスを提供します。 以下のタスクを実行できます。
  • ユーザ アカウントの最新のリストを取得します。
  • ユーザ アカウントを作成します。
  • ユーザ アカウントを変更します。
  • ユーザ アカウントを削除します。
以下のトピックでは、関連するパラメータについて説明します。
基本ユーザ アカウント パラメータ
以下のユーザ アカウント設定の現在値は GET 操作で取得できます。
http://PC_host:8181/pc/center/webservice/users/
cultureId
: この URL は、このコマンドを実行するために使用されるアカウントと同じテナントに関連付けられたユーザに関する情報を返します。
cultureId
には、出力を表示する言語の言語コード(「en-US」など)を指定します。
  • userID
    ユーザ アカウントに対して内部的に割り当てられた値。
  • name
    ユーザ アカウントのログイン名。 名前は 50 文字までに制限されています。
  • 説明
    (オプション)理解を促すためのユーザ アカウントに関する説明です。
  • enabled
    ユーザ アカウントが使用可能か(アクティブか)どうかを決定します。
  • removable
    項目が削除できるかどうか(データベースから削除)を指定します。
    値:
    true または false
    2 つの事前定義ユーザ アカウント(
    admin
    user
    )は削除できません。
  • timezone(tz)
    レポート データに表示されるタイムゾーンと一致します。
    デフォルト
    : UTC (協定世界時)。
  • userLevel
    このユーザ アカウントに割り当てられた製品権限を識別します。
  • 役割
    ユーザ アカウントに割り当てられた役割を指定します。
  • tenantId
    ユーザ アカウントが関連付けられているテナント用の内部(データベース)識別子です。
  • culture
    言語(ロケール)を指定します。 以下のリストからの言語識別子を提供します。
    • en - US(英語、米国)
    • ja - JP (日本語)
    • zh-CN (中国語(簡体字))
    • zh-TW (中国語(繁体字))
    • fr-FR (フランス語、フランス)
GET メソッドはパスワード情報を返しません。 新規ユーザ アカウントの作成時、パスワードはユーザ名と同じになるように自動的に設定されます。
個別の PUT メソッドを使用すると、指定されたユーザ アカウントのパスワードを更新できます。 Web サービスが使用する暗号キーが公表されないように、パスワードはクリア テキストで送信されます。 その結果、パスワードの変更方法は、パスワードの機密性を守るため、
NetOps Portal
ホストでだけ使われる必要があります。
ユーザ アカウント製品権限の設定
指定されたユーザ アカウントの製品権限を判断するには、
NetOps Portal
ユーザ インターフェースを使用します。 製品権限は、ユーザ アカウントに関連付けられた権限セットの一種です。 製品権限は、選択したデータ ソースの機能にユーザがアクセスすることを許可し、
NetOps Portal
の機能には適用されません。
ユーザ アカウントには、以下のいずれかの製品権限割り当てがあります。
  • NONE
    このユーザには指定されたデータ ソースへのアクセス権がないことを示します。
  • ADMINISTRATOR
    このユーザは、示されたデータ ソースに対して管理者製品権限があり、管理タスクを実行できることを示します。
  • POWER_USER
    このユーザは、示されたデータ ソースに対してパワー ユーザ製品権限があり、ユーザ アカウントとダッシュボードに関連付けられた一部の管理タスクを実行できることを示します。
  • USER
    このユーザは、示されたデータ ソースに対してユーザ製品権限があり、管理機能にはアクセス権がないことを示します。
ユーザ Web サービスの構文例
ユーザ Web サービスのパラメータおよび使用可能な操作を確認するには、次のコールを発行します。
http://
PC_host
:8181/pc/center/rest/users/documentation
使用可能な GET メソッド
  • get groups owned by user
    指定されたユーザのグループのリストを取得します。 返されるグループは、指定されたユーザが所有するグループです。つまり、このユーザはこれらのグループを変更または削除できます。
    http://
    PC_host
    :8181/pc/center/webservice/users/
    idName
    /
    idValue
    /groupsOwnedByUser
  • get groups
    指定されたユーザがビュー アクセス権限を持つグループのリストを取得します。 返されるグループは、指定されたユーザの権限セット内にあるグループです。 ユーザはこれらのグループを変更または削除できません。
    http://
    PC_host
    :8181/pc/center/webservice/users/
    idName
    /
    idValue
    /groups
  • get administered groups
    指定されたユーザ アカウントに関連付けられたすべての管理対象グループのリストを取得します。
    http://
    PC_host
    :8181/pc/center/webservice/users/idName/idValue/administeredGroups
  • get id names
    識別子のリストを取得します。他の Web サービス メソッドでこれを使用してユーザを識別できます。
    http://
    PC_host
    :8181/pc/center/webservice/users/idNames
    • idValue
      識別するカテゴリの値です。 たとえば、
      idName
      が userID である場合は、ユーザ ID を指定します。
      idName
      が userName である場合は、ユーザ名を指定します。
  • get authentication types
    ユーザに認証タイプを割り当てるために使用できる識別子のリストを返します。
    http://
    PC_host
    :8181/pc/center/webservice/users/authenticationTypes
使用可能な PUT メソッド
  • update role
    指定されたユーザ アカウントの役割割り当てを更新します。
    http://
    PC_host
    :8181/pc/center/webservice/users/
    idName
    /
    idValue
    /role/
    roleIdName
    /
    roleIdValue
  • update time zone
    指定されたユーザ アカウントのタイム ゾーンを更新します。
    http://
    PC_host
    :8181/pc/center/webservice/users/
    idName
    /
    idValue
    /timeZone/
    newTimeZone
  • set groups
指定されたユーザ アカウントに付与されている権限グループを更新します。
http://
PC_host
:8181/pc/center/webservice/users/
idName
/
idValue
/groups
グループを設定するには、以下の形式の XML を指定します。
<group> <group ID="5245"/> <group ID="5246"/> <group ID="5247"/> ... </group>
  • add groups
指定したグループを追加します。
http://
PC_host
:8181/pc/center/webservice/users/
idName
/
idValue
/addGroups
グループを追加するには、以下の形式の XML を指定します。
<group> <group ID="5245"/> <group ID="5246"/> <group ID="5247"/> ... </group>
  • remove groups
指定したグループを削除します。
http://
PC_host
:8181/pc/center/webservice/users/
idName
/
idValue
/removeGroups
グループを削除するには、以下の形式の XML を指定します。
<group> <group ID="5245"/> <group ID="5246"/> <group ID="5247"/> ... </group>
  • set administered groups
指定されたユーザが管理アクセス権を持つグループ ツリーのブランチを更新します。
http://
PC_host
:8181/pc/center/webservice/users/idName/idValue/administeredGroups
ユーザ アカウントに管理対象グループを設定するには、(たとえば)以下の形式の XML を指定します。
<group> <group ID="5245"/> <group ID="5246"/> <group ID="5247"/> ... </group>
  • set default group
    指定されたユーザのデフォルト グループを更新します。
    http://
    PC_host
    :8181/pc/center/webservice/users/
    idName
    /
    idValue
    /defaultGroup/
    groupId
    例:
    http://PC.broadcom.net:8181/pc/center/webservice/users/userId/7/defaultGroup/11
  • add administered groups
ユーザ アカウントに指定したグループを追加します。
http://
PC_host
:8181/pc/center/webservice/users/
idName
/
idValue
/addAdministeredGroups
ユーザ アカウントに管理対象グループを追加するには、(たとえば)以下の形式の XML を指定します。
<group> <group ID="5245"/> <group ID="5246"/> <group ID="5247"/> ... </group>
  • remove administered groups
ユーザ アカウントから指定したグループを削除します。
http://
PC_host
:8181/pc/center/webservice/users/
idName
/
idValue
/removeAdministeredGroups
ユーザ アカウントから管理対象グループを削除するには、(たとえば)以下の形式の XML を指定します。
<group> <group ID="5245"/> <group ID="5246"/> <group ID="5247"/> ... </group>
  • update product privilege per datasource
    指定されたユーザ アカウントの製品権限を更新し、特定のデータ ソースのユーザ インターフェースへのアクセスを有効にします。
    http://
    PC_host
    :8181/pc/center/webservice/users/
    idName
    /
    idValue
    /ds/
    dsId
    /productPrivilege/
    newProductPrivilege
    • dsId
      データ ソース識別子です。 使用可能なデータ ソース識別子のリストについては、「基本的なデータソース パラメータ」を参照してください。
使用可能な POST メソッド
  • 作成
    ユーザ アカウントを作成します。 新しいユーザはログイン ユーザのテナントと関連付けられます。 パラメータには役割割り当てが含まれます。
    http://
    PC_host
    :8181/pc/center/webservice/users/role/
    roleIdName
    /
    roleIdValue
  • create in tenant
    指定された役割割り当てを使用して、指定されたテナントにユーザ アカウントを作成します。
    http://
    PC_host
    :8181/pc/center/webservice/users/tenant/
    tenantIdName
    /
    tenantIdValue
    /role/
    roleIdName
    /
    roleIdValue
  • clear administered groups
    グループが選択されていないことを示す特殊な ID を持つ管理対象グループをクリアします。
    http://
    PC_host
    :8181/pc/center/webservice/users/idName/idValue/administeredGroups
    管理対象グループをクリアするには、以下の XML を指定します。
    <group>
    <group ID="2"/>
    </group>
REST を使用したユーザ アカウントの作成
カスタム ユーザ アカウントを作成するには、ユーザ Web サービスを使用します。 すべてのユーザ アカウントはテナントに自動的に関連付けられます。 マルチ テナントを展開している場合、新規ユーザは、REST サービス コールの作成に使用された認証済みユーザ アカウントのテナントに割り当てられます。 ユーザがマルチ テナントを展開していない場合、この関連付けは透過的に行われます。つまり、新規ユーザ アカウントはデフォルト テナントに関連付けられます。
以下の手順に従います。
  1. NetOps Portal
    ホストへ接続されている REST クライアントをセットアップします。
  2. REST クライアントに、
    NetOps Portal
    RESTful Web サービス API の URL を入力します。 次の形式を使用します:
    http://
    PC_host
    :8181/pc/center/webservice/users/role/
    roleIdName/roleIdValue
    /
    • roleIdName
      以下の URL で指定されている値を使用します。
      http://
      PC_host
      :8181/pc/center/webservice/roles/idNames
      例:
      • roleName
      • roleId
    • roleIdValue
      この値は、ユーザが選択した roleIdName に依存します。 たとえば「roleName」を使用する場合は、
      roleIdValue
      を有効な役割名に置き換えます。
      この役割はテナント内に利用できる必要があります。
  3. 「HTTP」メソッドにPOSTを選択します。
  4. NetOps Portal
    に対してホストまたはテナント管理者アクセス権があるユーザ アカウントの有効なユーザ名およびパスワードを指定します。
  5. Body 設定内の「Body Content-type」として「application/xml」を選択します。
  6. [Body]テキスト セクション内に、以下のパラメータを追加します。
    <user> <name>{UserName}</name> <description>{UserDescription}</description> <enabled>{UserEnabled}</enabled> <removable>{UserRemovable}</removable> <timezone>{UserTimeZone}</timezone> <culture>{UserCulture}</culture> <administeredGroups> <group ID="{groupID}"/> <group ID="{groupID}"/> </administeredGroups> </user>
  7. 任意の値を新しいテナントに対して使用する値に置換します。
    たとえば、以下のパラメータを提供します。
    <user> <name>Jane Doe</name> <description>User associated with the John Doe Corporation tenant.</description> <enabled>true</enabled> <removable>true</removable> <timezone>CST6CDT</timezone> <culture>en-US</culture> <administeredGroups> <group ID="105"/> <group ID="367"/> </administeredGroups> </user>
    administeredGroups タグはオプションです。 管理対象グループのないユーザを作成するには、タグを除外します。
  8. メソッドを実行します。
  9. 必要な数のユーザを作成するまで、前述の手順を繰り返します。
ユーザ アカウント製品権限の設定
指定されたユーザ アカウントの製品権限を判断するには、
NetOps Portal
ユーザ インターフェースを使用します。 製品権限は、ユーザ アカウントに関連付けられた権限セットの一種です。
製品権限は、選択したデータ ソースの機能にユーザがアクセスすることを許可し、
NetOps Portal
の機能には適用されません。
ユーザ アカウントには、以下のいずれかの製品権限割り当てがあります。
  • NONE
    このユーザには指定されたデータ ソースへのアクセス権がないことを示します。
  • ADMINISTRATOR
    このユーザは、示されたデータ ソースに対して管理者製品権限があり、管理タスクを実行できることを示します。
  • POWER_USER
    このユーザは、示されたデータ ソースに対してパワー ユーザ製品権限があり、ユーザ アカウントとダッシュボードに関連付けられた一部の管理タスクを実行できることを示します。
  • USER
    このユーザは、示されたデータ ソースに対してユーザ製品権限があり、管理機能にはアクセス権がないことを示します。