PATCH | Atualizar parcialmente a política de acesso por [id]

Descrição

Atualize configurações específicas de uma política de acesso no PAM Core. Apenas os campos enviados no corpo da requisição são alterados — todos os demais mantêm seus valores atuais, inclusive os campos do mesmo namespace. Os próprios namespaces podem ser enviados parcialmente.

Este é o endpoint indicado para alterações pontuais. Para atualizar todas as configurações em uma única requisição, acesse PUT | Atualizar política de acesso por [id], que redefine todo campo não enviado.

Para alterar apenas se a política está ativa, utilize POST | Ativar política de acesso ou POST | Desativar política de acesso. O campo active não pode ser modificado por este endpoint.

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 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.
• O valor atual do ETag da política de acesso, retornado por GET | Listar uma política de acesso por [id] e por todas as operações de escrita na política.

Requisição

PATCH /api/v2/pam/access-policies/{id}

Parâmetros de caminho

Cabeçalhos

Corpo da requisição

Envie apenas os namespaces e campos que deseja alterar. O corpo utiliza os mesmos nomes e tipos de campo de POST | Criar política de acesso — acesse esse artigo para consultar as tabelas completas de campos dos namespaces password, session, approvers_config, criteria e access_limitation.

Campos que não podem ser modificados

O envio de qualquer um desses campos retorna 422 com o código patch.field.not.allowed.

Exemplo de requisição

PATCH {{url}}/api/v2/pam/access-policies/3001

Cabeçalhos

Content-Type: application/merge-patch+json
If-Match: "v2"

Corpo

{
    "password": {
        "require_approval": false,
        "approvals_required": 0
    }
}

Esta requisição altera dois campos do namespace password. Todos os demais campos de password — e todos os demais namespaces — mantêm seus valores atuais.

Resposta

HTTP/1.1 200 OK
ETag: "v3"

O cabeçalho ETag contém a nova versão da política. Utilize esse valor no cabeçalho If-Match da próxima operação de escrita.

Exemplo de corpo da resposta

A resposta retorna a política de acesso completa, e não apenas os campos alterados.

{
    "data": {
        "id": 3001,
        "access_policy": {
            "name": "PAM Administrators - Updated",
            "active": true,
            "description": "Updated description."
        },
        "password": {
            "allow_view": true,
            "view_mode": "complete",
            "require_reason": true,
            "require_approval": false,
            "approvals_required": 0,
            "disapprovals_to_cancel": 1,
            "approval_in_levels": true,
            "allow_emergency_access": false,
            "allow_change_expiration": true,
            "change_expiration_minutes": 60,
            "require_approval_days": false,
            "approval_days": [],
            "approval_times": [],
            "approval_custom_times": []
        },
        "session": {
            "allow_start": true,
            "block_during_freezing": true,
            "require_reason": true,
            "require_approval": true,
            "approvals_required": 2,
            "disapprovals_to_cancel": 1,
            "approval_in_levels": true,
            "allow_emergency_access": false,
            "require_change_id": true,
            "require_approval_days": false,
            "approval_days": [],
            "approval_times": [],
            "approval_custom_times": []
        },
        "approvers_config": {
            "governance_id_required": true,
            "always_add_user_manager": false
        },
        "criteria": {
            "site_ids": [1, 2],
            "device_type_ids": [3],
            "credential_type_ids": [5],
            "devices": [],
            "products": [],
            "usernames": [],
            "additional_information": [],
            "device_tags": ["prod", "staging"],
            "credential_tags": []
        },
        "access_limitation": {
            "days": ["monday", "tuesday", "wednesday", "thursday", "friday"],
            "times": ["08:00-18:00"],
            "custom_times": [],
            "period_start": null,
            "period_end": null
        }
    },
    "meta": {
        "links": { "self": "/api/v2/pam/access-policies/3001" },
        "actions": {
            "deactivate": "/api/v2/pam/access-policies/3001/deactivate"
        }
    }
}

Campos do corpo da resposta

A resposta retorna a política de acesso completa, com os mesmos campos de GET | Listar uma política de acesso por [id]. Acesse esse artigo para consultar as tabelas completas de campos.

Erros

Exemplos de respostas de erro

412 — o ETag não corresponde à versão atual da política:

{
    "error": {
        "code": "api.precondition.failed",
        "message": "ETag does not match."
    }
}

422 — o corpo da requisição contém um campo que não pode ser modificado:

{
    "error": {
        "code": "patch.field.not.allowed",
        "message": "Field 'type' cannot be modified via PATCH."
    }
}

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