{ "opencollection": "1.0.0", "info": { "name": "Lightrun Actions Users API", "version": "v1" }, "items": [ { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "Get a list of users", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8090/api/v1/users", "params": [ { "name": "includeAccessAndPermissions", "value": "", "type": "query", "description": "Fetch group memberships and agent pool permissions.\nRequires RBAC." }, { "name": "page", "value": "", "type": "query", "description": "Specifies a zero-based index of the results page to retrieve. The default is 0 (the first page)." }, { "name": "role", "value": "", "type": "query", "description": "Filter by role." }, { "name": "search", "value": "", "type": "query", "description": "Search by name or email." }, { "name": "size", "value": "", "type": "query", "description": "The number of items to include on each page of results. The default is 20." }, { "name": "sort", "value": "", "type": "query", "description": "The sorting criteria in the format property (asc|desc), with ascending as the default. Multiple sort parameters can be chained to define primary, secondary, and further sorting levels (e.g., sort=field1,asc&sort=field2,desc). Sortable fields: name, email, userManagementType, createdBy, lastModifiedBy, lastModifiedDate, and lastLoginDate." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a list of users.\n\n**Required API permission level:** `COMPANY`" }, { "info": { "name": "Create a user", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8090/api/v1/users", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a user.\n\n**Required API permission level:** `COMPANY`" }, { "info": { "name": "Get a user by email", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8090/api/v1/users/:email", "params": [ { "name": "email", "value": "", "type": "path", "description": "Email." }, { "name": "includeAccessAndPermissions", "value": "", "type": "query", "description": "Fetch group memberships and agent pool permissions.\nRequires RBAC." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a user by email.\n\n**Required API permission level:** `COMPANY`" }, { "info": { "name": "Update a user", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8090/api/v1/users/:email", "params": [ { "name": "email", "value": "", "type": "path", "description": "Email." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update a user.\n\n**Required API permission level:** `COMPANY`" }, { "info": { "name": "Delete a user", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:8090/api/v1/users/:email", "params": [ { "name": "email", "value": "", "type": "path", "description": "Email." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a user.\n\n**Required API permission level:** `COMPANY`" }, { "info": { "name": "Disable a user", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8090/api/v1/users/:email/disable", "params": [ { "name": "email", "value": "", "type": "path", "description": "Email." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Disable a user.\n\n**Required API permission level:** `COMPANY`" }, { "info": { "name": "Enable a user", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8090/api/v1/users/:email/enable", "params": [ { "name": "email", "value": "", "type": "path", "description": "Email." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Enable a user.\n\n**Required API permission level:** `COMPANY`" } ] } ], "bundled": true }