ユーザー
ユーザー
User オブジェクトは、Notion ワークスペースのユーザーを表します。ユーザーには、完全なワークスペース メンバーと統合が含まれます。ゲストは含まれません。メンバーとゲストの詳細については、このガイドをご覧ください。
📘SCIM を使用したユーザーとグループのプロビジョニング
SCIM API は、Notion のエンタープライズ プランのワークスペースで利用できます。SCIM を Notion で使用する方法について詳しくは、こちらをご覧ください。
📘Notion でシングル サインオン (SSO) を設定する
シングル サインオン (SSO) は、Notion のエンタープライズ プランのワークスペースに対して構成できます。Notion を使用した SSO の詳細については、こちらをご覧ください。
API でユーザー オブジェクトが表示される場所
ユーザー オブジェクトは、API によって返されるほぼすべてのオブジェクトに表示されます。
created_by
とlast_edited_by
の下のブロック オブジェクト。created_by
とlast_edited_by
プロパティ項目の下およびpeople
中のページ オブジェクト。created_by
およびlast_edited_by
の下のデータベース オブジェクト。- ユーザーが言及しているように、リッチテキストオブジェクト。
- プロパティが
people
プロパティの場合のプロパティ オブジェクト。
以下で説明するように、ユーザー オブジェクトには常にobject
キーとid
キーが含まれます。残りのプロパティは、ユーザーがリッチ テキストまたはページ プロパティのコンテキストでレンダリングされており、ボットがそれらのプロパティにアクセスするための適切な機能を持っている場合に表示されることがあります。機能の詳細については、機能ガイドと認証ガイドを参照してください。
すべてのユーザー
これらのフィールドは、人やボットを含むすべてのユーザーによって共有されます。* でマークされたフィールドは常に存在します。
パロパティ | 更新可能 | タイプ | 説明 | 例の値 |
---|---|---|---|---|
object * |
表示のみ | "user" |
常に「ユーザー」 | "user" |
id * |
表示のみ | string (UUID) |
このユーザーの一意の識別子。 | "e79a0b74-3aba-4149-9f74-0bb5791a6ee6" |
type |
表示のみ | string (オプション、列挙型) |
ユーザーのタイプ。可能な値は"person" と"bot" です。 |
"person" |
name |
表示のみ | string (オプション) |
Notion に表示されるユーザー名。 | "Avocado Lovelace" |
avatar_url |
表示のみ | string (オプション) |
選択したアバター画像。 | "https://secure.notion-static.com/e6a352a8-8381-44d0-a1dc-9ed80e62b53d.jpg" |
人々
人を表すユーザー オブジェクトのtype
プロパティは"person"
に設定されています。これらのオブジェクトには、次のプロパティもあります。
パロパティ | 更新可能 | タイプ | 説明 | 例の値 |
---|---|---|---|---|
person |
表示のみ | object |
ボット以外のユーザーにのみ存在するプロパティ。 | |
person.email |
表示のみ | string |
個人の電子メール アドレス。これは、統合に電子メール アドレスへのアクセスを許可するユーザー機能がある場合にのみ存在します。 | "avo@example.org" |
ボット
ユーザー オブジェクトのtype
プロパティは"bot"
に設定されると、ユーザー オブジェクトがボットを表す場合です。ボット ユーザー オブジェクトには、次のプロパティがあります。
パロパティ | 更新可能 | タイプ | 説明 | 例の値 |
---|---|---|---|---|
bot |
表示のみ | object |
GET /v1/users/me またはGET /v1/users/{{your_bot_id}} を使用している場合、このフィールドはowner 、owner.type および workspace_name を含むボットに関するデータを返します。これらのプロパティについては、以下で詳しく説明します。 |
{ "object": "user", "id": "9188c6a5-7381-452f-b3dc-d4865aa89bdf", "name": "Test Integration", "avatar_url": null, "type": "bot", "bot": { "owner": { "type": "workspace", "workspace": true }, "workspace_name": "Ada Lovelace’s Notion" } } |
owner |
表示のみ | object |
このボットの所有者に関する情報。 | { "type": "workspace", "workspace": true } |
owner.type |
表示のみ | string 列挙 |
"workspace" または"user" のいずれかの所有者のタイプ。 |
"workspace" |
workspace_name |
表示のみ | string 列挙 |
owner.type が"workspace" の場合、workspace.name ボットを所有するワークスペースの名前を識別します。owner.type が"user" の場合、workspace.name はnull です。 |
最終更新: 2 years ago