{ "opencollection": "1.0.0", "info": { "name": "openobserve Actions Users API", "version": "0.90.0" }, "items": [ { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "List organization users", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/:org_id/users", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "Organization name" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieves a list of all users within the specified organization, including their roles, status, and basic profile information. Optionally filter to list users across all organizations if the requesting user has sufficient permissions. Returns user metadata such as email addresses, assigned roles, last login times, and account status." }, { "info": { "name": "Create new user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/:org_id/users", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "Organization name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Creates a new user account within the organization with specified role and authentication credentials. The password must be at least 8 characters long and the email address must be valid. Users are automatically assigned to the organization with the specified role and can begin accessing resources immediately upon creation." }, { "info": { "name": "Add user to organization", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/:org_id/users/:email_id", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "Organization name" }, { "name": "email_id", "value": "", "type": "path", "description": "User's email id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Adds an existing user account to the organization with the specified role assignment. The user must already exist in the system with valid authentication credentials. This operation grants the user access to organization resources and data according to their assigned role permissions." }, { "info": { "name": "Update user account", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/:org_id/users/:email_id", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "Organization name" }, { "name": "email_id", "value": "", "type": "path", "description": "User's email id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Updates user account information including role assignments, password changes, or other profile details. Users can modify their own account settings, while administrators have broader permissions to update any user account. Password changes require the new password to be at least 8 characters long for security compliance." }, { "info": { "name": "Remove user from organization", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/:org_id/users/:email_id", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "Organization name" }, { "name": "email_id", "value": "", "type": "path", "description": "User name" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Removes a user from the organization, immediately revoking their access to all organization resources, data, and services. The user account itself remains active and can be added back to organizations later. This action is permanent and cannot be undone without re-adding the user explicitly." } ] } ], "bundled": true }