compiler.UserInfo

ログインしたユーザーの詳細の取得

R2022a 以降

構文

user = compiler.UserInfo()

説明

user = compiler.UserInfo() は、MATLAB^® のデスクトップバージョンを実行しているマシンにログインしたユーザーの詳細、または MATLAB Web App Server™ にログインしたユーザーの詳細を返します。

例

すべて折りたたむ

デスクトップユーザーの詳細の取得

MATLAB コマンドプロンプトで、次を実行します。

user = compiler.UserInfo()

user = 
  UserInfo with properties:

         UserID: 'someid'
    DisplayName: <missing>
         Groups: <missing>
         Domain: 'SOME_DOMAIN'

サーバー上にある `userinfo.json` ファイルからのユーザーの詳細の取得

MATLAB Web App Server で詳細なユーザー情報を有効にするには、userinfo.json ファイルを作成して、webapps_private フォルダーに配置します。このファイルは、ID プロバイダー (IdP) のプロパティを MATLAB プロパティにマップし、そのデータにアクセスできるアプリを定義します。

{
  "version": "1.0.0",
  "userInfo.doc": "Property values to be fetched during login from IdP",
  "userInfo": {
    "UserID": "upn",
    "DisplayName": "displayName",
    "Groups": "groups",
    "LastName": "surname",
    "Email": "mail"
  },
  "appAccess.doc": "Policy for allowing access to user properties within an app or group of apps",
  "appAccess": {
    "Health/BloodPressure": ["UserID", "Email"],
    "Finance/Mortgage": ["UserID", "LastName"],
    "Mystery": ["UserID", "Email", "WebAppsRole"]
  }
}

appAccess オブジェクトのキーは、アプリのルートフォルダーに相対的な Web アプリの場所に対応します。アプリケーションがサブフォルダーに保存されている場合、マッピングにフォルダーパスを含める必要があります。

たとえば、BloodPressure アプリが Health という名前のフォルダー内に配置されている場合、JSON ファイル内のキーは "Health/BloodPressure" でなければなりません。アプリがルートアプリフォルダー内に直接配置されている場合は、アプリ名のみ ("Mystery" など) を使用します。

App Designer アプリの startupFcn 内で compiler.UserInfo 関数を使用して、アプリをカスタマイズします。

function startupFcn(app)
    try
        user = compiler.UserInfo();
    catch me
        % Handle errors if the server is not configured for authentication
        return
    end

    if ~ismissing(user.UserID)
        app.WelcomeLabel.Text = "Welcome, " + user.UserID;
    end
end

出力引数

すべて折りたたむ

`user` — ログインしたユーザーの詳細
`compiler.UserInfo` オブジェクト

返されるオブジェクトには、UserID、DisplayName、Groups などのプロパティおよび userinfo.json ファイル内で定義されている任意のカスタム属性が含まれます。特定のアプリにマップされていない、または許可されていないプロパティは、<missing> として返されます。

バージョン履歴

R2022a で導入

参考

ismissing | isprop

トピック

ユーザーに基づいてWebアプリの動作をカスタマイズする (MATLAB Web App Server)