ユーザーサービスのプロパティー

言語:

ユーザー名とパスワードに加えて、ユーザーサービスのプロパティーは、ユーザーに付与される承認、ユーザーに課される制限、ユーザーのロケールなどの特性を定義します。

ユーザープロパティー

ユーザーは次のプロパティーを設定できます。一部のプロパティーは、特定のタイプのユーザーのみが使用できます。

表 77 ユーザープロパティー

プロパティー	型	説明
`logname`	string	一意のユーザー名。`logname` は、ユーザーが作成された後は変更できません。
`type`	string	ユーザーのタイプ: `local`、`directory`、`data`、または `nologin`。`type` は、ユーザーが作成された後は変更できません。デフォルト: `local`
`uid`	number	ユーザー ID。自分でユーザー ID を指定することも、システムにユーザー ID を割り当てさせることもできます。ユーザー ID を指定する場合、ユーザー ID を 100 より小さくすること、2147483646 より大きくすること、60001、60002、または 65534 と等しくすることはできません。`uid` は、ユーザーが作成された後は変更できません。
`fullname`	string	ユーザーのフルネームまたは実際の名前。BUI では、ダッシュボードの上部にある「ログアウト」ボタンの左側にフルネームが表示され、ブラウザのタブに表示されることもあります。デフォルト: `logname` と同じ
`initial_password`	string	ローカルユーザーおよびデータユーザーのパスワード。
`require_annotation`	boolean	true の場合: BUI – ユーザーは、最初の BUI ページを表示する前にコメントを入力する必要があります。 CLI – ユーザーは、CLI プロンプトを表示する前にコメントを入力する必要があります。 REST – 未承認としてリクエストは失敗します。セッション注釈は監査ログに表示されます。
`roles`	list	ディレクトリユーザーまたはローカルユーザーに割り当てられたロール。
`kiosk_mode`	boolean	true の場合、このユーザーはキオスクユーザーになります。 BUI – ユーザーは、`kiosk_screen` プロパティーの値である画面のみの表示に制限されます。 CLI – ログインに失敗します。 REST – 未承認としてリクエストは失敗します。
`kiosk_screen`	string	`kiosk_mode` が true の場合に、このユーザーに許可される BUI 画面。デフォルト: `status/dashboard`
`exceptions`	list	ディレクトリユーザーまたはローカルユーザーに割り当てられた追加の承認、またはロールで割り当てられた承認に対する制限。
`preferences`	list	ユーザー環境のプリファレンス (ロケール、BUI 開始ページ、タイムアウト、SSH 公開鍵、REST ログイントークンなど)。

これらのプロパティーの詳細は、次のドキュメントを参照してください。

ユーザーのロールおよび例外

roles プロパティーを使用して、既存のロールをユーザーに割り当てます。ロールを作成するには、RESTful API ロールサービスを参照してください。

exceptions プロパティーを使用して、ユーザーの承認を追加します。このメカニズムを使用して、承認を削除することもできます。たとえば、ユーザーに特定の承認を付与するロールが割り当てられている場合、そのロールに含まれている他の承認を保持したまま、例外リストで個々の承認を false に設定できます。

次のリクエストでは、ユーザー user1 の Kerberos サービスを再起動するための承認を追加します。

POST /api/user/v1/users/user1/exceptions HTTP/1.1

{
    "scope": "svc",
    "service": "kerberos",
    "allow_restart": true
}

次の結果は、user1 の Kerberos サービスで使用できるすべての承認を示しています。この例では、他の承認のデフォルト値は false のままです。

{
    "auth": {
        "href": "/api/user/v1/users/user1/exceptions/auth-001",
        "scope": "svc",
        "service": "kerberos",
        "allow_administer": false,
        "allow_configure": false,
        "allow_restart": true
    }
}

ユーザー設定のプロパティー

ログインしているユーザー、または allow_changePreferences 承認を持っている任意のユーザーのプリファレンスを設定できます。allow_changePreferences 承認を得るには、ユーザーのロールおよび例外を参照してください。

表 78 ユーザー設定のプロパティー

プロパティー	型	説明
`locale`	string	地域。デフォルト: C
`login_screen`	string	ページが URL で指定されていない場合、ログインの成功時に表示される BUI ページです。デフォルト: `status/dashboard`
`session_timeout`	integer	ユーザーが BUI から移動したあとにブラウザが自動的にセッションからログアウトするまでの分数。デフォルト: 15
`cli_idle_timeout`	integer	セッションが中断されるまでに CLI をアイドル状態にできる時間の長さ (秒)。デフォルト値の `-1` の場合、CLI はアイドル時に自動的に閉じられません。
`advanced_analytics`	string	使用可能な高度な分析統計を作成します
`keys`	list	RSA/DSA 公開鍵
`tokens`	list	REST ログイントークン

これらのプロパティーの詳細は、次のセクションを参照してください。

CLI タイムアウト

デフォルトでは、CLI をアイドル状態にできる時間の長さに制限はありません (cli_idle_timeout の値は -1 です)。CLI をアイドル状態にできる時間の長さに制限を設定するには、cli_idle_timeout 秒に正の整数値を設定します。タイムアウトの制限に到達すると、CLI は閉じられます。

次の例では、CLI タイムアウトを 1 時間に設定します。

PUT /api/user/v1/users/user1/preferences HTTP/1.1

{ "cli_idle_timeout": 3600 }

{
    "preferences": {
        "href": "/api/user/v1/users/user1/preferences",
        "locale": "C",
        "login_screen": "configuration/preferences",
        "session_timeout": 15,
        "cli_idle_timeout": 3600,
        "advanced_analytics": false,
        "keys": [],
        "tokens": []
    }
}

タイムアウトを無効にするには、次の例に示すように、cli_idle_timeout の値を -1 に設定するか、unset を使用します。

PUT /api/user/v1/users/user1/preferences HTTP/1.1

{ "<unset>": ["cli_idle_timeout"] }

unset を山カッコで囲むと、unset という名前のプロパティーが存在するという問題を回避できます。

SSH 鍵

SSH 公開鍵は、パスワードを使わずに SSH 接続を許可するのに使用できます。

表 79 SSH 鍵プロパティー

プロパティー	型	説明
`type`	string	SSH 鍵のタイプです。RSA または DSA
`key`	string	SSH 鍵の内容
`comment`	string	SSH 鍵に関連付けられたコメント

REST ログイントークン

永続的または非永続的な REST ログイントークンを作成し、返されたトークン値またはトークン ID を介してトークンにアクセスできます。

表 80 REST ログイントークンのプロパティー

プロパティー	型	説明
`name`	string	トークン名。
`token_username`	string	このログイントークンを使用できるユーザーの名前。この値はリクエストパスに設定されます。
`preserve`	boolean	`false` の場合、デフォルトの `expiration` の値を使用します。`true` の場合、カスタムの `expiration` の値を設定します。デフォルト: `false`
`expiration`	number	トークンを作成する場合、この値はトークンの有効期限が切れるまでの秒数です。`preserve` が `true` に設定されている場合は、このプロパティーを設定する必要があります。`preserve` が `false` に設定されている場合、`expiration` の値は 900 です。トークンのプロパティーを一覧表示する場合、この値はこのトークンの有効期限が切れる日時です。

REST ログイントークンの問合せパラメータ

token=token 問合せパラメータを GET コマンドとともに使用して、そのトークンのプロパティー値を表示します。token=token 問合せパラメータを DELETE コマンドとともに使用して、そのトークンを削除します。token は、create token 応答の X-Auth-Session の値です。

token は、トークンが作成されたときに表示され、再度表示されることはありません。必ず token をコピーして保管しておいてください。使用例 3, REST ログイントークンの作成を参照してください。