v1

latestOpenAPI 3.1.02026-07-241280174.1 KB

Update

patch/v3/projects/roles/role/{role}

Path parameters

rolestring required

The role's unique identifier

Request body

namestring

The name of the role

permissionsstring[]

An array containing the permissions the role has. Valid permissions are: enclave_config_access_logs, enclave_config_change_request_policy_manage, enclave_config_change_request_review, enclave_config_logs, enclave_config_secrets_referencing, enclave_config_syncs_manage, enclave_config_toggle_inheritable, enclave_project_config_create, enclave_project_config_delete, enclave_project_config_duplicate, enclave_project_config_dynamic_secrets_leases_write, enclave_project_config_dynamic_secrets_manage, enclave_project_config_dynamic_secrets_read, enclave_project_config_lock, enclave_project_config_logs_rollback, enclave_project_config_rename, enclave_project_config_rotated_secrets_manage, enclave_project_config_rotated_secrets_read, enclave_project_config_secrets_read, enclave_project_config_secrets_write, enclave_project_config_service_tokens, enclave_project_config_trusted_ips, enclave_project_delete, enclave_project_environment_all, enclave_project_environment_create, enclave_project_environment_delete, enclave_project_environment_list_all, enclave_project_environment_order, enclave_project_environment_rename, enclave_project_environment_settings_manage, enclave_project_inheritance, enclave_project_members, enclave_project_rename, enclave_project_secrets_notes_manage, enclave_project_secrets_referencing, enclave_project_webhooks, enclave_secret_reminders

Response

200

Example response

{
  "role": {
    "name": "custom",
    "permissions": [
      "enclave_config_logs"
    ],
    "identifier": "custom",
    "created_at": "2023-08-01T00:00:00.000Z",
    "is_custom_role": true
  }
}