{
  "opencollection": "1.0.0",
  "info": {
    "name": "Gravitee.io - Access Management alerts role API",
    "version": "4.12.0-alpha.3"
  },
  "items": [
    {
      "info": {
        "name": "role",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List registered roles for a security domain",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/roles",
            "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"
              },
              {
                "name": "q",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "User must have the DOMAIN_ROLE[LIST] permission on the specified domain or DOMAIN_ROLE[LIST] permission on the specified environment or DOMAIN_ROLE[LIST] permission on the specified organization. Each returned role is filtered and contains only basic information such as id and name."
        },
        {
          "info": {
            "name": "Create a role",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/roles",
            "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_ROLE[CREATE] permission on the specified domain or DOMAIN_ROLE[CREATE] permission on the specified environment or DOMAIN_ROLE[CREATE] permission on the specified organization"
        },
        {
          "info": {
            "name": "Get a role",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/roles/:role",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "environmentId",
                "value": "",
                "type": "path"
              },
              {
                "name": "domain",
                "value": "",
                "type": "path"
              },
              {
                "name": "role",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "User must have the DOMAIN_ROLE[READ] permission on the specified domain or DOMAIN_ROLE[READ] permission on the specified environment or DOMAIN_ROLE[READ] permission on the specified organization"
        },
        {
          "info": {
            "name": "Update a role",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/roles/:role",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "environmentId",
                "value": "",
                "type": "path"
              },
              {
                "name": "domain",
                "value": "",
                "type": "path"
              },
              {
                "name": "role",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "User must have the DOMAIN_ROLE[UPDATE] permission on the specified domain or DOMAIN_ROLE[UPDATE] permission on the specified environment or DOMAIN_ROLE[UPDATE] permission on the specified organization"
        },
        {
          "info": {
            "name": "Delete a role",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/roles/:role",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "environmentId",
                "value": "",
                "type": "path"
              },
              {
                "name": "domain",
                "value": "",
                "type": "path"
              },
              {
                "name": "role",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "User must have the DOMAIN_ROLE[DELETE] permission on the specified domain or DOMAIN_ROLE[DELETE] permission on the specified environment or DOMAIN_ROLE[DELETE] permission on the specified organization"
        },
        {
          "info": {
            "name": "List registered roles of the organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/management/organizations/:organizationId/roles",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "type",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "User must have the ORGANIZATION_ROLE[LIST] permission on the specified organization. Each returned role is filtered and contains only basic information such as id, name, isSystem and assignableType."
        },
        {
          "info": {
            "name": "Create a role for the organization",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/management/organizations/:organizationId/roles",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "User must have the ORGANIZATION_ROLE[CREATE] permission on the specified organization"
        },
        {
          "info": {
            "name": "Get a platform role",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/management/organizations/:organizationId/roles/:role",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "role",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "User must have the ORGANIZATION_ROLE[READ] permission on the specified organization"
        },
        {
          "info": {
            "name": "Update a platform role",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/management/organizations/:organizationId/roles/:role",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "role",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "User must have the ORGANIZATION_ROLE[UPDATE] permission on the specified organization"
        },
        {
          "info": {
            "name": "Delete a plaform role",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/management/organizations/:organizationId/roles/:role",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "role",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "User must have the ORGANIZATION_ROLE[DELETE] permission on the specified organization"
        }
      ]
    }
  ],
  "bundled": true
}