{ "opencollection": "1.0.0", "info": { "name": "Gravitee.io - Access Management alerts Reporter API", "version": "4.12.0-alpha.3" }, "items": [ { "info": { "name": "Reporter", "type": "folder" }, "items": [ { "info": { "name": "List reporter plugins", "type": "http" }, "http": { "method": "GET", "url": "/management/platform/plugins/reporters" }, "docs": "There is no particular permission needed. User must be authenticated." }, { "info": { "name": "Get a reporter plugin", "type": "http" }, "http": { "method": "GET", "url": "/management/platform/plugins/reporters/:reporter", "params": [ { "name": "reporter", "value": "", "type": "path" } ] }, "docs": "There is no particular permission needed. User must be authenticated." }, { "info": { "name": "Get a reporter plugin's schema", "type": "http" }, "http": { "method": "GET", "url": "/management/platform/plugins/reporters/:reporter/schema", "params": [ { "name": "reporter", "value": "", "type": "path" } ] }, "docs": "Get a reporter plugin's schema" }, { "info": { "name": "List registered reporters for a security domain", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/reporters", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "userProvider", "value": "", "type": "query" } ] }, "docs": "User must have the DOMAIN_REPORTER[LIST] permission on the specified domain or DOMAIN_REPORTER[LIST] permission on the specified environment or DOMAIN_REPORTER[LIST] permission on the specified organization. Except if user has DOMAIN_REPORTER[READ] permission on the domain, environment or organization, each returned reporter is filtered and contains only basic information such as id and name and type." }, { "info": { "name": "Create a reporter for a security domain", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/reporters", "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_REPORTER[CREATE] permission on the specified domain or DOMAIN_REPORTER[CREATE] permission on the specified environment or DOMAIN_REPORTER[CREATE] permission on the specified organization." }, { "info": { "name": "Get a reporter", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/reporters/:reporter", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "reporter", "value": "", "type": "path" } ] }, "docs": "User must have the DOMAIN_REPORTER[READ] permission on the specified domain or DOMAIN_REPORTER[READ] permission on the specified environment or DOMAIN_REPORTER[READ] permission on the specified organization" }, { "info": { "name": "Update a reporter", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/reporters/:reporter", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "reporter", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "User must have the DOMAIN_REPORTER[UPDATE] permission on the specified domain or DOMAIN_REPORTER[UPDATE] permission on the specified environment or DOMAIN_REPORTER[UPDATE] permission on the specified organization" }, { "info": { "name": "Delete a reporter", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/reporters/:reporter", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "reporter", "value": "", "type": "path" } ] }, "docs": "User must have the DOMAIN_REPORTER[DELETE] permission on the specified domain or DOMAIN_REPORTER[DELETE] permission on the specified environment or DOMAIN_REPORTER[DELETE] permission on the specified organization" }, { "info": { "name": "List registered reporters for a security domain", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/reporters", "params": [ { "name": "organizationId", "value": "", "type": "path" } ] }, "docs": "User must have the ORGANIZATION_REPORTER[LIST] permission on the specified organization. Except if user has ORGANIZATION_REPORTER[READ] permission on the organization, each returned reporter is filtered and contains only basic information such as id and name and type." }, { "info": { "name": "Create a reporter for an organization", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/reporters", "params": [ { "name": "organizationId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "User must have the ORGANIZATION_REPORTER[CREATE] permission on the specified organization" }, { "info": { "name": "Get a reporter", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/reporters/:reporterId", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "reporterId", "value": "", "type": "path" } ] }, "docs": "User must have the ORGANIZATION_REPORTER[READ] permission on the organization" }, { "info": { "name": "Update a reporter", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/reporters/:reporterId", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "reporterId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "User must have the ORGANIZATION_REPORTER[UPDATE] permission on the specified organization" }, { "info": { "name": "Delete a reporter", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/reporters/:reporterId", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "reporterId", "value": "", "type": "path" } ] }, "docs": "User must have the ORGANIZATION_REPORTER[DELETE] permission on the specified organization" } ] } ], "bundled": true }