GET | Listar todas as políticas de acesso

Descrição

Liste as políticas de acesso disponíveis para a sua autorização no PAM Core. Retorna uma projeção paginada e filtrável da entidade.

Este endpoint retorna um conjunto reduzido de campos para cada política — o suficiente para identificá-la e filtrá-la. Para obter a configuração completa de uma única política, incluindo suas configurações de senha, sessão, aprovadores, critérios e limitação de acesso, acesse GET | Listar uma política de acesso por [id].

Pré-requisitos

Uma aplicação com a autorização Access Policy (V2) concedida pelo administrador no A2A, com a Permissão do recurso PAM definida como Apenas leitura ou Leitura e escrita. Para mais informações, acesse Como gerenciar autorizações no A2A.
Um token de acesso OAuth 2.0 válido. Para mais informações, acesse Como autenticar uma aplicação A2A.

Info

Um token de acesso carrega apenas as autorizações que existiam no momento em que foi gerado. Depois que o administrador habilitar a autorização Access Policy (V2), gere um novo token para a aplicação — um token existente não passa a ter a nova autorização.

Requisição

GET /api/v2/pam/access-policies

Parâmetros de query

Todos os parâmetros de query são opcionais. Quando nenhum parâmetro é informado, o endpoint retorna as políticas de acesso acessíveis à autorização, com os campos exibidos no exemplo de resposta.

Filtros

Campo	Tipo	Descrição
`name`	string	Filtra pelo nome da política. A correspondência é exata.
`active`	boolean	Filtra pelo status de ativação. Valores aceitos: `true`, `false`.
`search`	string	Pesquisa nos campos `name` e `description`.

Ordenação

Campo	Tipo	Descrição
`sort_by`	string	Ordena o conjunto de resultados no formato `campo:asc` ou `campo:desc`. Exemplo: `sort_by=name:asc`.

Para as regras completas de ordenação, acesse API v2 - Convenções e comportamentos compartilhados.

Paginação

Campo	Tipo	Descrição
`page`	integer	Número da página. Padrão: `1`.
`limit`	integer	Resultados por página. Padrão: `50`.

Para as regras completas de paginação, acesse API v2 - Convenções e comportamentos compartilhados.

Projeção de campos

Campo	Tipo	Descrição
`fields`	string	Restringe a resposta aos campos listados. Suporta todos os campos disponíveis nas representações de listagem e de detalhe.

Para a sintaxe completa de projeção de campos, acesse API v2 - Convenções e comportamentos compartilhados.

Exemplo de requisição

GET {{url}}/api/v2/pam/access-policies?page=1&limit=50&active=true

Resposta

HTTP/1.1 200 OK

Exemplo de corpo da resposta

{
    "data": [
        {
            "id": 3001,
            "access_policy": {
                "name": "PAM Administrators",
                "active": true,
                "description": "Full access for PAM admins."
            }
        },
        {
            "id": 3002,
            "access_policy": {
                "name": "SOC Analysts",
                "active": true,
                "description": "Read-only access for SOC."
            }
        }
    ],
    "meta": {
        "pagination": {
            "page": 1,
            "limit": 50,
            "total_items": 2,
            "total_pages": 1
        },
        "links": {
            "self": "/api/v2/pam/access-policies?page=1&limit=50&active=true"
        }
    }
}

Campos do corpo da resposta

Campo	Tipo	Descrição
`data`	array of objects	Lista das políticas de acesso que atendem aos filtros da requisição.
`data[].id`	integer	Código de identificação único da política de acesso, atribuído pelo Segura® em POST \| Criar política de acesso.
`data[].access_policy`	object	Atributos principais da política de acesso.
`data[].access_policy.name`	string	Nome da política de acesso.
`data[].access_policy.active`	boolean	Indica se a política está ativa.
`data[].access_policy.description`	string	Descrição da política de acesso. Retorna `null` quando não informada.
`meta`	object	Metadados de paginação e links de navegação.
`meta.pagination`	object	Detalhes de paginação do conjunto de resultados atual.
`meta.pagination.page`	integer	Número da página atual.
`meta.pagination.limit`	integer	Número máximo de resultados por página.
`meta.pagination.total_items`	integer	Número total de políticas de acesso que atendem aos filtros.
`meta.pagination.total_pages`	integer	Número total de páginas.
`meta.links`	object	Links de navegação do conjunto de resultados.
`meta.links.self`	string	URL da página atual.

Info

A representação de listagem retorna apenas o namespace access_policy de cada política. Os namespaces password, session, approvers_config, criteria e access_limitation são retornados somente por GET | Listar uma política de acesso por [id].

Erros

Código HTTP	Mensagem	Causa possível	Solução
`401`	`api.auth.token.invalid`	O token de acesso está ausente ou expirou.	Solicite um novo token de acesso.
`403`	`api.permission.denied`	A autorização não tem permissão para ler políticas de acesso.	Peça ao administrador para verificar a autorização Access Policy (V2) e a Permissão do recurso PAM no A2A e gere um novo token.
`422`	`api.enum.invalid_value`	Um filtro recebeu um valor fora da lista de valores permitidos, como um valor não booleano em `active`.	Verifique os parâmetros de query e reenvie a requisição.
`429`	`rate_limit_exceeded`	O limite de requisições foi excedido.	Reduza a frequência de requisições e tente novamente.
`500`	`api.internal.error`	Erro interno do servidor.	Entre em contato com a equipe de suporte da Segura®.

Para mensagens de erros de autenticação e a política de 403 versus 404, acesse API v2 - Convenções e comportamentos compartilhados.