{ "opencollection": "1.0.0", "info": { "name": "Gravitee.io - Access Management alerts group API", "version": "4.12.0-alpha.3" }, "items": [ { "info": { "name": "group", "type": "folder" }, "items": [ { "info": { "name": "List groups for a security domain", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/groups", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" } ] }, "docs": "User must have the DOMAIN_GROUP[LIST] permission on the specified domain or DOMAIN_GROUP[LIST] permission on the specified environment or DOMAIN_GROUP[LIST] permission on the specified organization. Each returned group is filtered and contains only basic information such as id and name." }, { "info": { "name": "Create a group", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/groups", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "User must have the DOMAIN_GROUP[CREATE] permission on the specified domain or DOMAIN_GROUP[CREATE] permission on the specified environment or DOMAIN_GROUP[CREATE] permission on the specified organization" }, { "info": { "name": "Get a group", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/groups/:group", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "group", "value": "", "type": "path" } ] }, "docs": "User must have the DOMAIN_GROUP[READ] permission on the specified domain or DOMAIN_GROUP[READ] permission on the specified environment or DOMAIN_GROUP[READ] permission on the specified organization" }, { "info": { "name": "Update a group", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/groups/:group", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "group", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "User must have the DOMAIN_GROUP[UPDATE] permission on the specified domain or DOMAIN_GROUP[UPDATE] permission on the specified environment or DOMAIN_GROUP[UPDATE] permission on the specified organization" }, { "info": { "name": "Delete a group", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/groups/:group", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "group", "value": "", "type": "path" } ] }, "docs": "User must have the DOMAIN_GROUP[DELETE] permission on the specified domain or DOMAIN_GROUP[DELETE] permission on the specified environment or DOMAIN_GROUP[DELETE] permission on the specified organization" }, { "info": { "name": "List group members", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/groups/:group/members", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "group", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" } ] }, "docs": "User must have the DOMAIN_GROUP[READ] permission on the specified domain or DOMAIN_GROUP[READ] permission on the specified environment or DOMAIN_GROUP[READ] permission on the specified organization" }, { "info": { "name": "Add a group member", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/groups/:group/members/:member", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "group", "value": "", "type": "path" }, { "name": "member", "value": "", "type": "path" } ] }, "docs": "User must have the DOMAIN_GROUP[UPDATE] permission on the specified domain or DOMAIN_GROUP[UPDATE] permission on the specified environment or DOMAIN_GROUP[UPDATE] permission on the specified organization" }, { "info": { "name": "Remove a group member", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/groups/:group/members/:member", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "group", "value": "", "type": "path" }, { "name": "member", "value": "", "type": "path" } ] }, "docs": "User must have the DOMAIN_GROUP[UPDATE] permission on the specified domain or DOMAIN_GROUP[UPDATE] permission on the specified environment or DOMAIN_GROUP[UPDATE] permission on the specified organization" }, { "info": { "name": "Get a group roles", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/groups/:group/roles", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "group", "value": "", "type": "path" } ] }, "docs": "User must have the DOMAIN_GROUP[READ] permission on the specified domain or DOMAIN_GROUP[READ] permission on the specified environment or DOMAIN_GROUP[READ] permission on the specified organization" }, { "info": { "name": "Assign roles to a group", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/groups/:group/roles", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "group", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "User must have the DOMAIN_GROUP[UPDATE] permission on the specified domain or DOMAIN_GROUP[UPDATE] permission on the specified environment or DOMAIN_GROUP[UPDATE] permission on the specified organization" }, { "info": { "name": "Revoke role to a group", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/groups/:group/roles/:role", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "group", "value": "", "type": "path" }, { "name": "role", "value": "", "type": "path" } ] }, "docs": "User must have the DOMAIN_GROUP[UPDATE] permission on the specified domain or DOMAIN_GROUP[UPDATE] permission on the specified environment or DOMAIN_GROUP[UPDATE] permission on the specified organization" }, { "info": { "name": "List groups of the organization", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/groups", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" } ] }, "docs": "User must have the ORGANIZATION[LIST] permission on the specified organization. Each returned group is filtered and contains only basic information such as id and name." }, { "info": { "name": "Create a platform group", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/groups", "params": [ { "name": "organizationId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "User must have the ORGANIZATION_GROUP[CREATE] permission on the specified organization" }, { "info": { "name": "Get a platform group", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/groups/:group", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "group", "value": "", "type": "path" } ] }, "docs": "User must have the ORGANIZATION_GROUP[READ] permission on the specified organization" }, { "info": { "name": "Update a platform group", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/groups/:group", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "group", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "User must have the ORGANIZATION_GROUP[READ] permission on the specified organization" }, { "info": { "name": "Delete a platform group", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/groups/:group", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "group", "value": "", "type": "path" } ] }, "docs": "User must have the ORGANIZATION_GROUP[READ] permission on the specified organization" }, { "info": { "name": "List group members", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/groups/:group/members", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "group", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" } ] }, "docs": "User must have the ORGANIZATION_GROUP[READ] permission on the specified organization" }, { "info": { "name": "Add a group member", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/groups/:group/members/:member", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "group", "value": "", "type": "path" }, { "name": "member", "value": "", "type": "path" } ] }, "docs": "User must have the ORGANIZATION_GROUP[UPDATE] permission on the specified organization" }, { "info": { "name": "Remove a group member", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/groups/:group/members/:member", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "group", "value": "", "type": "path" }, { "name": "member", "value": "", "type": "path" } ] }, "docs": "User must have the ORGANIZATION_GROUP[UPDATE] permission on the specified organization" } ] } ], "bundled": true }