# Get all roles

Endpoint: GET /roles
Version: 5.1.47
Security: api_key

## Query parameters:

  - `page_number` (integer)
    The page number for which to get roles. This will default to the first page if excluded

  - `page_size` (integer)
    The maximum number of objects to return. This will default to the DefaultApiPageSize setting if not provided

## Response 200 fields (application/json):

  - `_pageInfo` (object)

  - `_pageInfo.numberOnPage` (integer)
    The number of items on this page. This should always match the page size unless it is the last page.

  - `_pageInfo.total` (integer)
    The total number of items

  - `responseList` (array)
    Example: [{"roleName":"NewRole","environment":{"copy":true,"create":true,"delete":true,"export":false,"import":false,"run":false,"update":true,"view":true},"connector":{"copy":false,"create":true,"delete":true,"export":false,"import":false,"run":false,"update":true,"view":true},"ruleset":{"copy":true,"create":true,"delete":true,"export":false,"import":false,"run":false,"update":true,"view":true},"inventory":{"copy":false,"create":false,"delete":false,"export":true,"import":true,"run":false,"update":true,"view":true},"profileJob":{"copy":false,"create":true,"delete":true,"export":false,"import":false,"run":true,"update":true,"view":true},"maskingJob":{"copy":false,"create":true,"delete":true,"export":false,"import":false,"run":true,"update":true,"view":true},"tokenizeJob":{"copy":false,"create":true,"delete":true,"export":false,"import":false,"run":true,"update":true,"view":true},"reidentifyJob":{"copy":false,"create":true,"delete":true,"export":false,"import":false,"run":true,"update":true,"view":true},"domain":{"copy":false,"create":true,"delete":true,"export":false,"import":false,"run":false,"update":true,"view":true},"algorithm":{"copy":false,"create":true,"delete":true,"export":false,"import":false,"run":false,"update":true,"view":true},"jdbcDriver":{"copy":false,"create":true,"delete":true,"export":false,"import":false,"run":false,"update":true,"view":true},"passwordVault":{"copy":false,"create":false,"delete":false,"export":false,"import":false,"run":false,"update":false,"view":false},"plugin":{"copy":false,"create":true,"delete":true,"export":false,"import":false,"run":false,"update":true,"view":true},"classifier":{"copy":false,"create":true,"delete":true,"export":false,"import":false,"run":false,"update":true,"view":true},"profileSet":{"copy":false,"create":true,"delete":true,"export":false,"import":false,"run":false,"update":true,"view":true},"fileFormat":{"copy":false,"create":true,"delete":true,"export":false,"import":false,"run":false,"update":false,"view":true},"user":{"copy":false,"create":true,"delete":true,"export":false,"import":false,"run":false,"update":true,"view":true},"diagnostic":{"copy":false,"create":false,"delete":false,"export":false,"import":false,"run":false,"update":false,"view":true},"inventoryReport":{"copy":false,"create":false,"delete":false,"export":false,"import":false,"run":false,"update":false,"view":true},"approveInventories":{"copy":false,"create":false,"delete":false,"export":false,"import":false,"run":false,"update":false,"view":true}}]

  - `responseList.roleId` (integer)
    The ID of the Role. This field will be generated by the Masking Engine.

  - `responseList.roleName` (string, required)
    The name for this Role. Note that it must be unique.
    Example: "NewRole"

  - `responseList.roleType` (string)
    The type for this Role. All built-in roles will have type as 'DEFAULT' while roles created by user will have type as 'CUSTOM'.
    Enum: "CUSTOM", "DEFAULT"

  - `responseList.environment` (object)
    Example: {"copy":true,"delete":true,"view":true}

  - `responseList.environment.copy` (boolean)
    This field indicates whether or not this privilege has the ability to copy the object it is applied to.
    Example: true

  - `responseList.environment.create` (boolean)
    This field indicates whether or not this privilege has the ability to create the object it is applied to.

  - `responseList.environment.delete` (boolean)
    This field indicates whether or not this privilege has the ability to delete the object it is applied to.
    Example: true

  - `responseList.environment.export` (boolean)
    This field indicates whether or not this privilege has the ability to export the object it is applied to.

  - `responseList.environment.import` (boolean)
    This field indicates whether or not this privilege has the ability to import the object it is applied to.

  - `responseList.environment.run` (boolean)
    This field indicates whether or not this privilege has the ability to run the object it is applied to.

  - `responseList.environment.update` (boolean)
    This field indicates whether or not this privilege has the ability to update the object it is applied to.

  - `responseList.environment.view` (boolean)
    This field indicates whether or not this privilege has the ability to view the object it is applied to.
    Example: true

  - `responseList.connector` (object)
    Example: {"copy":true,"delete":true,"view":true}

  - `responseList.ruleset` (object)
    Example: {"copy":true,"delete":true,"view":true}

  - `responseList.inventory` (object)
    Example: {"copy":true,"delete":true,"view":true}

  - `responseList.profileJob` (object)
    Example: {"copy":true,"delete":true,"view":true}

  - `responseList.maskingJob` (object)
    Example: {"copy":true,"delete":true,"view":true}

  - `responseList.tokenizeJob` (object)
    Example: {"copy":true,"delete":true,"view":true}

  - `responseList.reidentifyJob` (object)
    Example: {"copy":true,"delete":true,"view":true}

  - `responseList.domain` (object)
    Example: {"copy":true,"delete":true,"view":true}

  - `responseList.algorithm` (object)
    Example: {"copy":true,"delete":true,"view":true}

  - `responseList.jdbcDriver` (object)
    Example: {"copy":true,"delete":true,"view":true}

  - `responseList.passwordVault` (object)
    Example: {"copy":true,"delete":true,"view":true}

  - `responseList.plugin` (object)
    Example: {"copy":true,"delete":true,"view":true}

  - `responseList.classifier` (object)
    Example: {"copy":true,"delete":true,"view":true}

  - `responseList.profileSet` (object)
    Example: {"copy":true,"delete":true,"view":true}

  - `responseList.fileFormat` (object)
    Example: {"copy":true,"delete":true,"view":true}

  - `responseList.user` (object)
    Example: {"copy":true,"delete":true,"view":true}

  - `responseList.diagnostic` (object)
    Example: {"copy":true,"delete":true,"view":true}

  - `responseList.inventoryReport` (object)
    Example: {"copy":true,"delete":true,"view":true}

  - `responseList.approveInventories` (object)
    Example: {"copy":true,"delete":true,"view":true}


## Response 400 fields

## Response 403 fields