Canvas 開発者ガイド
jUser
User オブジェクトは、現在のユーザーに関するコンテキスト情報を含む JSON 形式のオブジェクトです。この情報は、キャンバスアプリケーション内で使用できます (ユーザー名を表示する場合など)。また、後続コールを行って追加情報を取得するために使用することもできます (現在のユーザーのロール情報を取得する場合など)。
| 項目 | 説明 |
|---|---|
| accessibilityModeEnabled | コンテキストユーザーについて、視覚障害者のためのユーザーインターフェースの変更が可能かどうかを示します (可能な場合は true、不可能な場合は false)。 |
| currencyISOCode | マルチ通貨組織のコンテキストユーザーのデフォルト通貨コードまたは単一通貨の組織の組織の通貨コードを返します。 |
| コンテキストユーザーのメールアドレス。 | |
| firstName | コンテキストユーザーの名前 (ファーストネーム)。 |
| fullName | コンテキストユーザーの氏名。形式は、Firstname Lastname です。 |
| isDefaultNetwork | コンテキストユーザーについて、そのユーザーが Experience Cloud サイトに存在するか (true)、否か (false) を示します。 |
| language | コンテキストユーザーの言語。文字列の長さは、2 - 5 文字です。最初の 2 文字は常に、「fr」や「en」などの ISO 言語コードです。値がさらに国別に評価される場合、文字列はアンダースコア (_) に続き、「US」や「UK」などの ISO 国コードが続きます。たとえば、アメリカを示す文字列は「en_US」、カナダのフランス語圏を示す文字列は「fr_CA」です。 |
| lastName | コンテキストユーザーの姓。 |
| locale | コンテキストユーザーのロケール。 |
| networkId | コンテキストユーザーが現在ログインしている Experience Cloud サイトの ID。 |
| profileId | 現在コンテキストユーザーに割り当てられているロールに関連付けられたプロファイルの ID。 |
| profilePhotoUrl | Chatter が有効化されている場合のコンテキストユーザーのプロファイル写真の URL。写真がアップロードされるたびに URL が更新され、最新の写真が反映されます。新しい写真がアップロードされた場合、古い写真で返されていた URL では写真が返されることが保証されません。この項目を使用して最新の写真の URL を必ず照会してください。 |
| profileThumbnailUrl | Chatter が有効化されている場合の、コンテキストユーザーのプロファイル写真のサムネイルの URL。写真がアップロードされるたびに URL が更新され、最新の写真が反映されます。新しい写真がアップロードされた場合、古い写真で返されていた URL では写真が返されることが保証されません。この項目を使用して最新の写真の URL を必ず照会してください。 |
| roleId | コンテキストユーザーの現在割り当てられているロールの ID。 |
| siteUrl | コンテキストユーザーが現在ログインしている Experience Cloud サイトの URL。 |
| siteUrlPrefix | コンテキストユーザーが現在ログインしている Experience Cloud サイトの URL プレフィックス。 |
| timeZone | コンテキストユーザーのタイムゾーン。 |
| userId | コンテキストユーザーの ID。 |
| userName | コンテキストユーザーのログイン名。 |
| userType | コンテキストユーザーに関連付けられたプロファイルのユーザーライセンスの種別。 |
次のコードスニペットに、User オブジェクトの例を示します。