{ "opencollection": "1.0.0", "info": { "name": "API Reference subpackage_actions subpackage_users API", "version": "1.0.0" }, "items": [ { "info": { "name": "subpackage_users", "type": "folder" }, "items": [ { "info": { "name": "✨ Get current user info", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8000/api/current-user", "headers": [ { "name": "Authorization", "value": "" } ] }, "docs": "\n \"Label\n

\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n

\n
\nGet info about the currently authenticat" }, { "info": { "name": "✨ Update current user", "type": "http" }, "http": { "method": "PATCH", "url": "http://localhost:8000/api/current-user", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n \"Label\n

\n This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n

\n
\nUpdate details for the currently authent" }, { "info": { "name": "Get user hotkeys", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8000/api/current-user/hotkeys/", "headers": [ { "name": "Authorization", "value": "" } ] }, "docs": "Retrieve the custom hotkeys configuration for the current user." }, { "info": { "name": "Update user hotkeys", "type": "http" }, "http": { "method": "PATCH", "url": "http://localhost:8000/api/current-user/hotkeys/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the custom hotkeys configuration for the current user." }, { "info": { "name": "Reset user token", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8000/api/current-user/reset-token/", "headers": [ { "name": "Authorization", "value": "" } ] }, "docs": "Reset the user token for the current user." }, { "info": { "name": "Get user token", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8000/api/current-user/token", "headers": [ { "name": "Authorization", "value": "" } ] }, "docs": "Get a user token to authenticate to the API as the current user." }, { "info": { "name": "Retrieve my user", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8000/api/current-user/whoami", "headers": [ { "name": "Authorization", "value": "" } ] }, "docs": "Retrieve details of the account that you are using to access the API." }, { "info": { "name": "List users", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8000/api/users/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." } ] }, "docs": "List the users that exist on the Label Studio server." }, { "info": { "name": "Create new user", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8000/api/users/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a user in Label Studio." }, { "info": { "name": "Get user info", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8000/api/users/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "User ID" } ] }, "docs": "Get info about a specific Label Studio user, based on the user ID." }, { "info": { "name": "Update user details", "type": "http" }, "http": { "method": "PATCH", "url": "http://localhost:8000/api/users/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "User ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "\n Update details for a specific user, such as their name or contact information, in Label Studio.\n " }, { "info": { "name": "Delete user", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:8000/api/users/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "User ID" } ] }, "docs": "Delete a specific Label Studio user. Only available in community edition.\n\nUse caution when deleting a user, as this can cause issues such as breaking the \"Annotated by\" filter or leaving orphaned records." } ] } ], "bundled": true }