{ "opencollection": "1.0.0", "info": { "name": "Lightrun Actions User Groups API", "version": "v1" }, "items": [ { "info": { "name": "User Groups", "type": "folder" }, "items": [ { "info": { "name": "Get a list of user groups", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8090/api/v1/groups", "params": [ { "name": "agentPoolIds", "value": "", "type": "query", "description": "Filter by access to agent pool IDs. Matches any of the agent pool IDs. Format: Comma-separated list of IDs." }, { "name": "includeMembers", "value": "", "type": "query", "description": "Fetch group members." }, { "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": "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). Supports multiple criteria." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a list of user groups.\n\n**Required API permission level:** `COMPANY`" }, { "info": { "name": "Create a group", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8090/api/v1/groups", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a group.\n\n**Required API permission level:** `COMPANY`" }, { "info": { "name": "Get a group by ID", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8090/api/v1/groups/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Group ID." }, { "name": "includeMembers", "value": "", "type": "query", "description": "Fetch group members." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a group by ID.\n\n**Required API permission level:** `COMPANY`" }, { "info": { "name": "Update a group", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8090/api/v1/groups/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Group ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update a group.\n\n**Required API permission level:** `COMPANY`" }, { "info": { "name": "Delete a group", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:8090/api/v1/groups/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Group ID." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a group.\n\n**Required API permission level:** `COMPANY`" }, { "info": { "name": "Add group members", "type": "http" }, "http": { "method": "POST", "url": "http://localhost:8090/api/v1/groups/:id/members", "params": [ { "name": "id", "value": "", "type": "path", "description": "Group ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "\n\n**Required API permission level:** `COMPANY`" }, { "info": { "name": "Remove group members in bulk", "type": "http" }, "http": { "method": "DELETE", "url": "http://localhost:8090/api/v1/groups/:id/members", "params": [ { "name": "id", "value": "", "type": "path", "description": "Group ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "\n\n**Required API permission level:** `COMPANY`" }, { "info": { "name": "Update a group member", "type": "http" }, "http": { "method": "PUT", "url": "http://localhost:8090/api/v1/groups/:id/members/:email", "params": [ { "name": "email", "value": "", "type": "path", "description": "Email." }, { "name": "id", "value": "", "type": "path", "description": "Group ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "\n\n**Required API permission level:** `COMPANY`" } ] } ], "bundled": true }