Web Application Usage RBAC Usage

K2HR3 REST API

K2HR3システムのAPIサーバーは、Webアプリケーション、Webサーバー、K2HR3 OpenStack Notification Listenerと、ユーザ(USER)の管理するホスト(HOST)からアクセスされる REST API を提供します。
このREST APIの説明をします。

トークン(TOKEN)について

K2HR3システムは、REST APIの利用方法として、トークン(TOKEN)の未指定指定の2つのアクセス方法を提供します。
REST APIへトークン(TOKEN)を指定してアクセスする場合、REST APIは、トークン(TOKEN)を読み取り、アクセス元を認可します。
K2HR3システムの提供するRBAC機能の特徴は、トークン(TOKEN)を使わず、リソース(RESOURCE)にアクセスできることです。よって、ROLEから利用されるREST APIはトークン(TOKEN)を使わず利用できるように設計されています。

このトークン(TOKEN)の種類と内容、およびREST APIとの関係について、以下に説明します。

トークン(TOKEN)の種類

K2HR3 APIサーバーの提供するREST APIで使うトークン(TOKEN)には以下の種類があります。

ユーザ(USER)トークン(TOKEN)

K2HR3のユーザ(USER)別に発行されるトークン(TOKEN)です。
このトークン(TOKEN)は、REST APIにアクセスするとき、対象となるデータ・操作に対してユーザ(USER)が権限を持つか確認するために使用されます。

ロール(ROLE)トークン(TOKEN)

ロール(ROLE)別に発行されるトークン(TOKEN)です。
このトークン(TOKEN)は、REST APIにアクセスするとき、対象となるデータ・操作に対してロール(ROLE)が権限を持つか確認するために使用されます。

REST APIへのアクセス

REST APIへのアクセスは、以下のように3種類の方法があります。

K2HR3 REST API - Token Access

REST API説明

K2HR3システムが提供するREST APIを説明します。
REST APIによっては、上述のトークン(TOKEN)の内容を事前に理解しておく必要があります。

VERSION API

K2HR3 REST APIのAPIリスト(バージョン別)を取得するAPI群です。

TOKEN API

K2HR3 REST APIのトークン(TOKEN)に関連するAPI群です。

LIST API

K2HR3 REST APIのリソース(RESOURCE)、ロール(ROLE)、ポリシー/ルール(POLICY)のパスリストに関連するAPI群です。

ROLE API

K2HR3 REST APIのロール(ROLE)に関連するAPI群です。

RESOURCE API

K2HR3 REST APIのリソース(RESOURCE)に関連するAPI群です。

POLICY API

K2HR3 REST APIのポリシー/ルール(POLICY)に関連するAPI群です。

SERVICE API

K2HR3 REST APIのサービス(SERVICE)に関連するAPI群です。

ACR(ACCESS CROSS ROLE) API

K2HR3 REST APIの+サービス(+SERVICE)機能で利用するACR(ACCESS CROSS ROLE)に関連するAPI群です。

USERDATA API

K2HR3 REST APIのUSER DATA SCRIPTに関連するAPI群です。

Web Application Usage RBAC Usage