> ## Documentation Index > Fetch the complete documentation index at: https://docsnewgen.flexxible.com/llms.txt > Use this file to discover all available pages before exploring further. # Listar papéis > Retorna uma lista paginada de papéis disponíveis dentro do escopo da organização. ## OpenAPI ````yaml /pt-BR/api-reference/openapi.pt-v2.json get /v2/organizations/{organization_id}/roles openapi: 3.0.3 info: title: API Publica Portal version: 2.0.0 description: API pública REST para portal servers: - url: https://api.flexxible.net description: Portal API (production) security: - bearerAuth: [] tags: - name: Atividade digital description: Criação de grupos de processos principais por organização - name: Roles description: Endpoint de creacion de roles de organizacion - name: Usuarios description: Endpoint de creacion de usuarios de organizacion - name: Grupos de workspaces description: Endpoints de gestión de grupos de workspaces - name: Workspaces description: Endpoint de eliminacion de workspaces de la organizacion - name: Aplicaciones instaladas description: Endpoint de detalle de aplicación instalada de la organización - name: Autenticación description: Endpoints de autenticación y contexto de sesión - name: Microservicios description: Detalle de microservicios por organizacion - name: Operaciones description: Consulta de detalle de operaciones por organización - name: Organización description: Operaciones de organización - name: Objetivos de política de parches description: Endpoints de gestión de objetivos de política de parches - name: Configuraciones de producto description: Endpoints de gestión de configuraciones de producto - name: Grupos de reporte description: Operaciones sobre grupos de reporte - name: Sesiones description: Endpoint de detalle de sesion de la organizacion - name: Tenants description: Endpoints de gestión de tenants paths: /v2/organizations/{organization_id}/roles: get: tags: - Funções summary: Listar papéis description: >- Retorna uma lista paginada de papéis disponíveis dentro do escopo da organização. operationId: get_roles parameters: - name: organization_id in: path required: true schema: type: string pattern: ^[0-9a-f]{24}$ minLength: 24 maxLength: 24 description: Identificador da organização. example: 507f1f77bcf86cd799439011 - name: page in: query required: false schema: type: integer default: 1 minimum: 1 description: Número da página. - name: per_page in: query required: false schema: type: integer default: 100 minimum: 1 maximum: 100 description: Número de elementos por página. - name: fields in: query required: false schema: type: string maxLength: 2048 description: >- Nomes dos campos do item de resposta, separados por vírgulas, a serem incluídos. - name: filters in: query required: false schema: type: string maxLength: 5120 description: >- Expressão de filtros JSON sobre caminhos de campos filtráveis da resposta. examples: simple: summary: Filtrar por nome do papel value: '{"field":"name","op":"contains","value":"administrador"}' complex-and: summary: Filtrar por tokens combinados do nome do papel value: >- {"and":[{"field":"name","op":"contains","value":"organización"},{"field":"name","op":"contains","value":"administrador"}]} complex-or-and: summary: Combinar condições OU e E value: >- {"and":[{"or":[{"field":"name","op":"contains","value":"administrador"},{"field":"name","op":"contains","value":"operador"}]},{"field":"name","op":"contains","value":"rol"}]} - name: sort in: query required: false schema: type: string pattern: ^(id|organization_id|name|created_at|created_by):(asc|desc)$ description: Expressão de orden no formato :asc|desc. responses: '200': description: Papéis recuperados com sucesso. content: application/json: schema: $ref: '#/components/schemas/GetRolesResponseV2' examples: paginated_result: summary: Lista paginada com papéis value: has_next: true data: - id: 64f0c2a1b2d3e4f5060708aa organization_id: 507f1f77bcf86cd799439011 name: Administrador de la organización created_at: '2026-03-12T10:30:00Z' created_by: 64f0c2a1b2d3e4f5060708bb permissions: - portal_permission: organization_admin workspaces_permission: admin analyzer_permission: access target_organization: all target_reporting_groups: - 64f0c2a1b2d3e4f5060708c1 empty_result: summary: Nenhum papel encontrado value: has_next: false data: [] '400': description: Parâmetros de solicitação inválidos. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: invalid_filters: summary: Formato de filtros inválido value: error: message: Formato de filtros inválido code: bad_request details: filters debe ser una cadena JSON válida '401': description: Não autorizado ou a organização não é acessível. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: organization_not_authorized: summary: Falha de acesso à organização value: error: message: No autorizado code: unauthorized '404': description: >- O recurso solicitado não foi encontrado dentro do escopo autorizado da organização. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: resource_not_found: summary: Não se encontrou o recurso solicitado value: error: message: No encontrado code: not_found '500': description: Erro interno do servidor. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: unexpected_error: summary: Falha não controlada value: error: message: Error interno del servidor code: internal_error components: schemas: GetRolesResponseV2: type: object properties: has_next: type: boolean description: Indica se há outra página disponível. data: type: array items: $ref: '#/components/schemas/RoleV2' required: - has_next - data ErrorResponse: type: object properties: error: type: object properties: message: type: string code: type: string details: type: string required: - message - code required: - error RoleV2: type: object properties: id: type: string pattern: ^[0-9a-f]{24}$ minLength: 24 maxLength: 24 description: Identificador do papel. name: type: string description: Nome do papel. organization_id: type: string pattern: ^[0-9a-f]{24}$ minLength: 24 maxLength: 24 description: Identificador da organização associada a este papel. created_at: type: string format: date-time description: Carimbo de tempo de criação do papel em formato ISO 8601. created_by: type: string nullable: true pattern: ^[0-9a-f]{24}$ minLength: 24 maxLength: 24 description: Identificador do usuário que criou o papel. permissions: type: array nullable: true description: Entradas de permissões configuradas para este papel. items: $ref: '#/components/schemas/GetRolePermissionItemV2' required: - id - name - organization_id - created_at - created_by GetRolePermissionItemV2: type: object properties: portal_permission: type: string nullable: true enum: - admin - organization_admin - organization_admin_read_only - user - platform - l1_support_team - l1_support_team_read_only - l2_support_team - l2_support_team_read_only - l3_engineering_team - l3_engineering_team_read_only - billing description: Nível de permissão do Portal. workspaces_permission: type: string nullable: true enum: - no_access - l1_support_team_read_only - l1_support_team - l2_support_team_read_only - l2_support_team - l3_engineering_team_read_only - l3_engineering_team - admin_read_only - admin description: Nível de permissão do Workspaces. analyzer_permission: type: string nullable: true enum: - no_access - access - admin description: Nível de permissão do Analyzer. target_organization: oneOf: - type: string enum: - all - type: string pattern: ^[0-9a-f]{24}$ minLength: 24 maxLength: 24 description: >- Âmbito de organização da permissão: `all` para todas as organizações ou um `organization_id` específico. target_reporting_groups: oneOf: - type: string enum: - all - type: array minItems: 1 items: type: string pattern: ^[0-9a-f]{24}$ minLength: 24 maxLength: 24 description: >- Âmbito dos grupos de relatório da permissão: `all` para todos os grupos ou lista de `reporting_group_id` específicos. required: - target_organization - target_reporting_groups securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````