(日本語版)Notion API - Public Beta
    (日本語版)Notion API - Public Beta
    • 概要
    • インテグレーション機能
    • リクエスト制限
    • ステータス コード
    • ブロック
    • ユーザー
    • コメント
    • リンク プレビューのUnfurl属性オブジェクト
    • バージョン変更
      • バージョニング
      • バージョンによる変更
    • ページ
      • ページ
      • ページのプロパティ
    • データベース
      • データベース
      • データベースのプロパティ
    • その他
      • 絵文字オブジェクト
      • ファイルオブジェクト
      • 親オブジェクト
      • リッチテキストオブジェクト
    • エンドポイント
      • 認証
        • 認証
        • Tokenを作成
      • ブロック
        • ブロックを取得
        • ブロックを更新
        • ブロックの子を取得
        • ブロックの子を追加
        • ブロックを削除
      • データベース
        • データベース エントリのフィルタ
        • データベース エントリの並べ替え
        • データベースのプロパティを更新する
        • データベースを作成
        • データベースを取得
        • データベースを更新
        • データベースにクエリを実行
      • ユーザー
        • 全てユーザーのリストを取得
        • トークンのボットユーザーを取得
        • ユーザーを取得
      • ページ
        • ページをアーカイブ
        • ページを作成
        • ページを取得
        • ページプロパティアイテムを取得
        • ページプロパティを更新
      • コメント
        • コメントを作成
        • コメントを取得
      • 検索
        • タイトルで検索

    ユーザー

    ユーザー#

    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表示のみobjectGET /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です。
    更新日時 2023-04-28 07:07:46
    前へ
    ブロック
    次へ
    コメント
    Built with