役割 Web サービス

API は、役割 Web サービスを提供し、ユーザがユーザ アカウントの役割を参照、作成、変更できるようにします。
capm250
API は、役割 Web サービスを提供し、ユーザがユーザ アカウントの役割を参照、作成、変更できるようにします。
役割は、ユーザ アカウントに割り当てられるパラメータであり、製品機能およびダッシュボード ページへのユーザ アクセスを制御します。
ユーザのジョブ機能に基づき、役割では、役割の権限を使用して製品設定への管理アクセス権を付与します。
役割によって、ユーザは役職を実行するのに必要なデータおよび製品機能にアクセスできるようになり、必要としない機能へのアクセスは制限されます。 ユーザ アカウントにカスタムまたは工場出荷時設定の役割を割り当てるには、ユーザ RESTful Web サービスを使用します。
基本的な役割パラメータ
以下のユーザ アカウント役割の現在値は GET コマンドから使用可能です。
  • accessRights
    この役割に割り当てられている役割権限です。 割り当てに使用できる役割権限は複数ありますが、一部の役割権限はデータ ソースに固有です。 使用可能なすべての役割権限のリストを取得するには、
    categoryId
    が必要です。 値 1 を持つ categoryId は CA
    NetOps Portal
    および Data Aggregator の両方に対応します。
  • culture
    言語(ロケール)を指定します。 以下のリストからの言語識別子を提供します。
    • en - US(英語、米国)
    • ja - JP (日本語)
    • zh-CN (中国語(簡体字))
    • fr-FR (フランス語、フランス)
  • 説明
    (オプション)理解を促すための役割に関する説明です。
  • enabled
    役割が使用できる(アクティブなっている)かどうかを決定します。 有効な値は true または false です。
  • name
    役割の名前です。 名前は 50 文字までに制限されています。
  • selections
    カテゴリに整理されており、この役割に選択的に付与できるアクセス権限のセットを提供します。
  • userCount
    この役割がユーザ アカウントに割り当てられているユーザの数です。
  • userID
    役割に対して内部的に割り当てられた値です。
役割 Web サービスの構文例
役割 Web サービスで使用可能な操作およびパラメータを確認するには、次のコールを発行します。
http://
PC_host
:8181/pc/center/rest/roles/documentation
使用可能な GET メソッド
  • get access rights
    指定された役割に割り当てられている役割権限のリストを取得します。 以下の構文を使用します。
    http://
    PC_host
    :8181/pc/center/webservice/roles/idName/idValue/rights/cultureId
  • get access rights by category
    指定されたカテゴリで使用可能なすべての役割権限のリストを取得します。 カテゴリは CA
    NetOps Portal
    またはデータ ソースのいずれかです。 1 の categoryId は CA
    NetOps Portal
    と Data Aggregator の両方に適用されます。
    http://
    PC_host
    :8181/pc/center/webservice/roles/rights/categoryid/cultureId
  • get category
    categoryId が含まれる XML ドキュメントを取得します。
    http://
    PC_host
    :8181/pc/center/webservice/roles/rights/categories/en-US
  • get by tenant
    ログイン ユーザのテナントと関連付けられているすべての役割のリストを取得します。 以下の構文を使用します。
    http://
    PC_host
    :8181/pc/center/webservice/roles/idName/idValue/rights/tenant/tenantIdName/tenantIdValue/cultureId
  • get categoryId
    使用可能なカテゴリ ID を表示する XML を取得します。
    http://
    PC_host
    :8181/pc/center/webservice/roles/rights/categories/cultureId
    値 1 は、CA
    NetOps Portal
    および Data Aggregator に対応します。 このカテゴリのみに含まれる役割の権限は Data Aggregator データ ソースに適用されます。
  • get id names
    識別子のリストを取得します。他の Web サービス メソッドでこれを使用して役割を識別できます。 以下の構文を使用します。
    http://
    PC_host
    :8181/pc/center/webservice/roles/idNames
使用可能な PUT メソッド
  • copy
    役割をコピーします。 このメソッドは、指定された役割のコピーを作成し、ログイン ユーザのテナントに関連付けます。 以下の構文を使用します。
    http://
    PC_host
    :8181/pc/center/webservice/roles/idName/idValue/copy/roleName/description/enabled/cultureId
  • 更新
    指定された役割を変更します。 役割名およびテナント ID は、役割パラメータの必須エレメントです。
    http://
    PC_host
    :8181/pc center/webservice/roles/idName/idValue/cultureId
使用可能な POST メソッド
  • 作成
    役割を作成します。 新しい役割はログイン ユーザのテナントに関連付けられます。
    http://
    PC_host
    :8181/pc/center/webservice/roles/
  • create for tenant
    役割を作成し、指定されたテナントにそれを割り当てます。
    http://
    PC_host
    :8181/pc/center/webservice/roles/tenant/tenantIdName/tenantIdValue
役割の作成
ユーザ アカウントの役割を作成するには、役割 Web サービスを使用します。
役割 Web サービスのパラメータを確認するには、次のコールを発行します。
http://
PC_host
:8181/pc/center/webservice/roles
以下の手順に従います。
  1. REST クライアントに、CA
    NetOps Portal
    RESTful Web サービス API の URL を入力します。 次の形式を使用します:
    http://
    PC_host
    :8181/pc /center/webservice/roles
  2. 「HTTP」メソッド
    POST
    を選択します。
  3. NetOps Portal
    へのグローバル管理者アクセス権を持つユーザ アカウントの有効なユーザ名およびパスワードを指定します。
  4. Body 設定内の「
    Body Content-type
    」として「
    application/xml
    」を選択します。
  5. 以下の例のような XML を[Body]フィールドに貼り付けます。
    <role> <name>TestRoleName</name> <description>Test Role Description</description> <enabled>true</enabled> <accessRights> <accessRight> <accessRightName>ViewToS</accessRightName> <categoryId>1</categoryId> <enabled>true</enabled> </accessRight> </accessRights> </role>
    • accessRights
      役割権限に対応します。
    • accessRightName
      役割権限の名前です。 たとえば、administerGroups 役割権限をユーザに付与すると、そのユーザはグループ ツリーのセクションの一部を管理できるようになります。
    • categoryId
      CA
      NetOps Portal
      の役割権限やデータ ソース固有の役割権限など、役割権限のカテゴリを識別します。
  6. メソッドを実行します。