{ "opencollection": "1.0.0", "info": { "name": "Kong Enterprise Admin ACLs Roles API", "version": "3.14.0" }, "request": { "auth": { "type": "apikey", "key": "Kong-Admin-Token", "value": "{{Kong-Admin-Token}}", "placement": "header" } }, "items": [ { "info": { "name": "Roles", "type": "folder" }, "items": [ { "info": { "name": "Get Predefined Roles", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/roles" }, "docs": "Retrieves the predefined, or system managed, roles." }, { "info": { "name": "List Team Roles", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/teams/:teamId/assigned-roles", "params": [ { "name": "teamId", "value": "", "type": "path", "description": "The team ID" }, { "name": "filter", "value": "", "type": "query", "description": "Filter roles returned in the response." } ] }, "docs": "Lists the roles belonging to a team. Returns 400 if any filter parameters are invalid." }, { "info": { "name": "Assign Team Role", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}:{port}{path}/v3/teams/:teamId/assigned-roles", "params": [ { "name": "teamId", "value": "", "type": "path", "description": "The team ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Assigns a role to a team. Returns 409 if role is already assigned." }, { "info": { "name": "Get Team Role", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/teams/:teamId/assigned-roles/:roleId", "params": [ { "name": "teamId", "value": "", "type": "path", "description": "The team ID." }, { "name": "roleId", "value": "", "type": "path", "description": "The role ID." } ] }, "docs": "Returns the assigned role for the specified ID." }, { "info": { "name": "Remove Team Role", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}:{port}{path}/v3/teams/:teamId/assigned-roles/:roleId", "params": [ { "name": "teamId", "value": "", "type": "path", "description": "The team ID." }, { "name": "roleId", "value": "", "type": "path", "description": "The role ID." } ] }, "docs": "Removes an assigned role from a team. Returns 404 if the requested team or assigned role were not found." }, { "info": { "name": "List User Roles", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/users/:userId/assigned-roles", "params": [ { "name": "userId", "value": "", "type": "path", "description": "The user ID" }, { "name": "filter", "value": "", "type": "query", "description": "Filter roles returned in the response." } ] }, "docs": "Lists the roles assigned to a user. Returns 400 if any filter parameters are invalid." }, { "info": { "name": "Assign Role", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}:{port}{path}/v3/users/:userId/assigned-roles", "params": [ { "name": "userId", "value": "", "type": "path", "description": "The user ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Assigns a role to a user. Returns 409 if role is already assigned." }, { "info": { "name": "Get User Role", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/users/:userId/assigned-roles/:roleId", "params": [ { "name": "userId", "value": "", "type": "path", "description": "ID of the user." }, { "name": "roleId", "value": "", "type": "path", "description": "ID of the role." } ] }, "docs": "Returns the assigned role for the specified ID." }, { "info": { "name": "Remove Role", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}:{port}{path}/v3/users/:userId/assigned-roles/:roleId", "params": [ { "name": "userId", "value": "", "type": "path", "description": "ID of the user." }, { "name": "roleId", "value": "", "type": "path", "description": "ID of the role." } ] }, "docs": "Removes an assigned role from a user. Returns 404 if the requested user or assigned role were not found." } ] } ], "bundled": true }