ユーザー更新
    • PDF

    ユーザー更新

    • PDF

    Article summary

    Patch
    /api/users/{user_id}

    ユーザー情報を更新します。
    アカウント特権管理者の委譲はAPI経由で行えません。ユーザー管理画面で行ってください。

    Security
    API Key
    Header parameter nameAuthorization

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

    Path parameters
    user_id
    integer (int64) Required

    ユーザーID

    Body parameters
    object
    role
    string

    ユーザー権限

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

    基本機能の利用可否
    監査ログ機能が利用できないアカウントの場合は指定しても反映されません。

    ExampleTrue
    can_use_audit_log
    boolean | null

    監査ログ機能の利用可否
    監査ログ機能が利用できないアカウントの場合は指定しても反映されません。

    ExampleTrue
    is_restricted_connection_modify
    boolean | null

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

    ExampleFalse
    Responses
    200

    更新したユーザーの詳細を返します。

    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
    400

    不正なリクエストです。

    401

    ユーザー更新権限がないか、API KEYが不正です。

    404

    指定したユーザーが存在しません。


    Was this article helpful?