Contents x
    ユーザー一覧取得
      • Print
      • PDF
      Contents

      ユーザー一覧取得

        • Print
        • PDF
        Article summary

        Get
        /api/users

        ユーザー一覧を取得します。

        Security
        API Key
        Header parameter nameAuthorization

        認証キーとなるAPI KEYをAuthorization: Token {{API KEY}}の形式でヘッダーにセットします。
        API KEYがabc123の場合は、Authorization: Token abc123とします。
        API KEYの作成方法は、trocco APIについてを参照ください。

        Query parameters
        limit
        integer (int64)

        取得するユーザーの最大件数

        Maximum200
        Default50
        cursor
        string

        取得するユーザー一覧の最初のレコードを示すページネーションカーソル
        レスポンスに含まれるnext_cursorをセットすると、後続のユーザー一覧を取得できます。

        ExampleeyJpZCI6MjF9
        Responses
        200

        ユーザー一覧を返します。

        Expand All
        object
        items
        Array of object
        object
        id
        integer (int64)

        ユーザーID

        Example1
        email
        string

        ユーザーのEメールアドレス

        Exampletrocco@example.com
        role
        string

        ユーザーの権限

        Valid values[ "\"super_admin\"", "\"admin\"", "\"member\"" ]
        Exampleadmin
        can_use_basic_services
        boolean

        基本機能の利用可否
        監査ログ機能が利用できないアカウントの場合はレスポンスに含まれません。

        ExampleTrue
        can_use_audit_log
        boolean

        監査ログ機能の利用可否
        監査ログ機能が利用できないアカウントの場合はレスポンスに含まれません。

        ExampleTrue
        is_restricted_connection_modify
        boolean

        接続情報の作成・編集・削除の禁止

        ExampleFalse
        last_sign_in_at
        string | null

        最終ログイン日時

        Example2023-08-23T03:00:00.000+09:00
        created_at
        string

        ユーザーの登録日時

        Example2023-08-23T03:00:00.000+09:00
        updated_at
        string

        ユーザーの更新日時

        Example2023-08-23T03:00:00.000+09:00
        next_cursor
        string

        後続のページネーションリクエストの取得開始レコードを示すカーソル値です。

        401

        認証エラーです。API KEYをご確認ください。

        Was this article helpful?
        What's Next