> For the complete documentation index, see [llms.txt](https://docs.ovaledge.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ovaledge.com/administration/security/api-attribute.md).

# API Attribute

In OvalEdge, API access settings seamlessly extend to individual API attributes (fields/parameters with request and response bodies), eliminating the need for separate configurations for each attribute.

Administrators can view and update governance roles associated with API attributes, ensuring consistent and streamlined governance across the entire API.

<figure><img src="https://content.gitbook.com/content/gnJyYKHzsnoFOdZJtHsc/blobs/xHHlqXEzKlX0MELtfXDa/image.png" alt=""><figcaption></figcaption></figure>

Based on the selected Data Source (Connection Name), the corresponding API Attributes are displayed along with the governance roles, users, and roles with metadata and data permissions on those API Attributes.

**Permissions and Governance (Inherits from API)**

SGA and OE\_ADMIN can manage permissions and governance roles for individual API attributes. However, these settings inherit from the API level by default, ensuring consistency and reducing configuration overhead.

**Permissions:**

* **Individual and Bulk Management:** Add, modify, or delete Metadata (view/edit) and Data access permissions for users and roles (including Governance Roles) on single or multiple API attributes.
* **Role-Based Access Control:** Based on the license limitations, define the level of Metadata and Data access permissions for specific roles.
* **API Attribute Admin:** Assign a role as admin for an API attribute, granting them the highest permissions (though inheritance from API admin typically applies).

**Governance Roles:**

* **Inherited by Default:** Governance roles defined at the API level are automatically inherited by their attributes.
* **Override Inherited Roles (Optional):** SGA and OE\_ADMIN can update governance roles for individual attributes if needed, creating exceptions to the inherited settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.ovaledge.com/administration/security/api-attribute.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
