> For the complete documentation index, see [llms.txt](https://cortex-docs.paloaltonetworks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cortex-docs.paloaltonetworks.com/xdr-api/identity-and-access-management-iam/objects.md).

# Objects

Operations for managing who can access objects such as dashboards, report templates, scripts, playbooks, and saved queries.

## Get the access settings of an object

> Returns the general access setting of an object and the role of every principal that has access to it, including the owner. A principal is a user, a user group, or an API key principal.\
> \
> The calling API key must have permission to share the object.\
> \
> \*\*Required license:\*\* Cortex XDR.

```json
{"openapi":"3.0.2","info":{"title":"Cortex XDR IAM APIs","version":"Cortex XDR 6.0"},"tags":[{"name":"Objects","description":"Operations for managing who can access objects such as dashboards, report templates, scripts, playbooks, and saved queries."}],"servers":[{"url":"https://api-{fqdn}","variables":{"fqdn":{"default":"cortex.paloaltonetworks.com","description":"The Fully Qualified Domain Name for the Cortex instance"}}}],"paths":{"/public_api/v1/object/get_access":{"post":{"tags":["Objects"],"summary":"Get the access settings of an object","description":"Returns the general access setting of an object and the role of every principal that has access to it, including the owner. A principal is a user, a user group, or an API key principal.\n\nThe calling API key must have permission to share the object.\n\n**Required license:** Cortex XDR.","operationId":"getObjectAccess","parameters":[{"name":"Authorization","in":"header","description":"{api_key}","required":true,"schema":{"type":"string"}},{"name":"x-xdr-auth-id","in":"header","description":"{api_key_id}","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Identifies the object and the change to apply. Send the fields at the top level of the body; do not wrap them in `request_data`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AclObjectGetAccessRequest"}}}},"responses":{"200":{"description":"The access settings of the object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AclObjectGetAccessResponse"}}}},"400":{"description":"Bad request. The request body is invalid, for example a required field is missing, an unknown field is present, or `object_type` is not supported.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AclObjectErrorResponse"}}}},"401":{"description":"Unauthorized access. The calling API key or its ID is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AclObjectErrorResponse"}}}},"403":{"description":"Forbidden. The calling API key cannot share the object, or the object is a system object whose access is managed by the system.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AclObjectErrorResponse"}}}},"404":{"description":"Not found. No object of the specified type exists with the specified ID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AclObjectErrorResponse"}}}},"500":{"description":"Internal server error. An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AclObjectErrorResponse"}}}}}}}},"components":{"schemas":{"AclObjectGetAccessRequest":{"type":"object","description":"Request body for getting the access settings of an object.","additionalProperties":false,"required":["object_type","object_id"],"properties":{"object_type":{"type":"string","description":"Type of the object. The value is case-insensitive.\n\n- `dashboards`: Dashboards.\n- `report_templates`: Report templates.\n- `scripts`: Automation scripts.\n- `playbooks`: Playbooks.\n- `xql_library`: Saved queries in the Query Library.","enum":["dashboards","report_templates","scripts","playbooks","xql_library"]},"object_id":{"type":"string","minLength":1,"description":"Unique identifier of the object, as a string. For example, `\"60\"` for a dashboard.\n\n- Report templates: You can display the template ID by adding the ID column to the report templates table in the UI.\n- Playbooks and scripts: Use the `id` field of the playbook or script."}}},"AclObjectGetAccessResponse":{"type":"object","description":"Access settings of the object.","properties":{"reply":{"type":"object","description":"Access settings of the object.","additionalProperties":false,"required":["general_access","access_entries"],"properties":{"general_access":{"type":"string","enum":["Restricted","Public"],"description":"General access of the object. `Public` lets every user whose role grants access to this type of object view it. `Restricted` limits access to the principals in the object's access entries, including the owner."},"access_entries":{"type":"array","items":{"$ref":"#/components/schemas/AclObjectAccessEntry"},"description":"Every principal with access to the object and its role, including the owner."}}}}},"AclObjectAccessEntry":{"type":"object","description":"The role of a single principal on the object.","additionalProperties":false,"required":["principal_id","principal_type","role"],"properties":{"principal_id":{"type":"string","description":"Identifier of the principal. The format depends on `principal_type`:\n\n- `User`: The user's email address, as returned in `user_email` by **List all users**.\n- `User Group`: The user group ID, as returned in `group_id` by **List all user groups**.\n- `API Key`: The numeric ID of the API key principal, as a string, as returned in `id` by [Get existing API Keys](https://app.gitbook.com/s/FK89utN7l3ilSek2DmU5/cortex-platform/api-keys) in the Cortex Platform APIs. This is the API key that has access to the object, not the calling API key."},"principal_type":{"type":"string","enum":["User","User Group","API Key"],"description":"Type of the principal. `API Key` refers to an API key principal, an API key that has access to the object. It does not refer to the calling API key."},"role":{"type":"string","enum":["Viewer","Editor","Owner"],"description":"Role of the principal on the object.\n\n- `Owner`: Full control, including deleting the object and managing its access.\n- `Editor`: Can view and edit the object.\n- `Viewer`: Can view the object."}}},"AclObjectErrorResponse":{"type":"object","description":"Error returned by the object access control APIs.","properties":{"reply":{"type":"object","description":"Error details.","properties":{"err_code":{"type":"string","description":"Error code. Codes specific to these APIs:\n\n| Code | HTTP status | Meaning |\n|---|---|---|\n| `ACL_PAPI_001` | 404 | The object was not found. |\n| `ACL_PAPI_002` | 403 | The calling API key does not have permission to perform this action on the object, or a principal is not eligible to access the object type. |\n| `ACL_PAPI_003` | 500 | The change could not be applied. |\n| `ACL_PAPI_004` | 403 | Ownership of system objects cannot be transferred. |\n| `ACL_PAPI_005` | 400 | The owner's access cannot be changed with **Grant, change, or revoke access to an object**. |\n| `ACL_PAPI_006` | 400 | The specified user cannot own the object. |\n| `ACL_PAPI_007` | 403 | The object is a system object whose access is managed by the system. |"},"err_msg":{"type":"string","description":"Error message."},"err_extra":{"type":"string","nullable":true,"description":"Additional information about the error, if any."}}}}}}}}
```

## Set the general access of an object

> Sets the general access of a single object.\
> \
> \- \`Public\`: Every user whose role grants access to this type of object can view the object.\
> \- \`Restricted\`: Only the principals in the object's access entries, including the owner, can access the object.\
> \
> Changing the general access does not change the object's access entries.\
> \
> The calling API key must have the \*\*Access Management\*\* permission (\`access\_management\_action\`). It must also have permission to view the object and to change its general access. Whether owners and editors can change general access depends on the granular access settings of the tenant.\
> \
> \*\*Required license:\*\* Cortex XDR.

```json
{"openapi":"3.0.2","info":{"title":"Cortex XDR IAM APIs","version":"Cortex XDR 6.0"},"tags":[{"name":"Objects","description":"Operations for managing who can access objects such as dashboards, report templates, scripts, playbooks, and saved queries."}],"servers":[{"url":"https://api-{fqdn}","variables":{"fqdn":{"default":"cortex.paloaltonetworks.com","description":"The Fully Qualified Domain Name for the Cortex instance"}}}],"paths":{"/public_api/v1/object/set_general_access":{"post":{"tags":["Objects"],"summary":"Set the general access of an object","description":"Sets the general access of a single object.\n\n- `Public`: Every user whose role grants access to this type of object can view the object.\n- `Restricted`: Only the principals in the object's access entries, including the owner, can access the object.\n\nChanging the general access does not change the object's access entries.\n\nThe calling API key must have the **Access Management** permission (`access_management_action`). It must also have permission to view the object and to change its general access. Whether owners and editors can change general access depends on the granular access settings of the tenant.\n\n**Required license:** Cortex XDR.","operationId":"setObjectGeneralAccess","parameters":[{"name":"Authorization","in":"header","description":"{api_key}","required":true,"schema":{"type":"string"}},{"name":"x-xdr-auth-id","in":"header","description":"{api_key_id}","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Identifies the object and the change to apply. Send the fields at the top level of the body; do not wrap them in `request_data`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AclObjectSetGeneralAccessRequest"}}}},"responses":{"200":{"description":"The request succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AclObjectStatusResponse"}}}},"400":{"description":"Bad request. The request body is invalid, for example a required field is missing, an unknown field is present, or `object_type` is not supported.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AclObjectErrorResponse"}}}},"401":{"description":"Unauthorized access. The calling API key or its ID is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AclObjectErrorResponse"}}}},"403":{"description":"Forbidden. The calling API key lacks the Access Management permission or cannot change the general access of the object, or the object is a system object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AclObjectErrorResponse"}}}},"404":{"description":"Not found. No object of the specified type exists with the specified ID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AclObjectErrorResponse"}}}},"500":{"description":"Internal server error. An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AclObjectErrorResponse"}}}}}}}},"components":{"schemas":{"AclObjectSetGeneralAccessRequest":{"type":"object","description":"Request body for setting the general access of an object.","additionalProperties":false,"required":["object_type","object_id","general_access"],"properties":{"object_type":{"type":"string","description":"Type of the object. The value is case-insensitive.\n\n- `dashboards`: Dashboards.\n- `report_templates`: Report templates.\n- `scripts`: Automation scripts.\n- `playbooks`: Playbooks.\n- `xql_library`: Saved queries in the Query Library.","enum":["dashboards","report_templates","scripts","playbooks","xql_library"]},"object_id":{"type":"string","minLength":1,"description":"Unique identifier of the object, as a string. For example, `\"60\"` for a dashboard.\n\n- Report templates: You can display the template ID by adding the ID column to the report templates table in the UI.\n- Playbooks and scripts: Use the `id` field of the playbook or script."},"general_access":{"type":"string","enum":["Restricted","Public"],"description":"General access of the object. `Public` lets every user whose role grants access to this type of object view it. `Restricted` limits access to the principals in the object's access entries, including the owner."}}},"AclObjectStatusResponse":{"type":"object","description":"Result of the operation.","properties":{"reply":{"type":"object","description":"Result of the operation.","required":["status"],"properties":{"status":{"type":"string","enum":["Success"],"description":"Always `Success` when the request succeeds."}}}}},"AclObjectErrorResponse":{"type":"object","description":"Error returned by the object access control APIs.","properties":{"reply":{"type":"object","description":"Error details.","properties":{"err_code":{"type":"string","description":"Error code. Codes specific to these APIs:\n\n| Code | HTTP status | Meaning |\n|---|---|---|\n| `ACL_PAPI_001` | 404 | The object was not found. |\n| `ACL_PAPI_002` | 403 | The calling API key does not have permission to perform this action on the object, or a principal is not eligible to access the object type. |\n| `ACL_PAPI_003` | 500 | The change could not be applied. |\n| `ACL_PAPI_004` | 403 | Ownership of system objects cannot be transferred. |\n| `ACL_PAPI_005` | 400 | The owner's access cannot be changed with **Grant, change, or revoke access to an object**. |\n| `ACL_PAPI_006` | 400 | The specified user cannot own the object. |\n| `ACL_PAPI_007` | 403 | The object is a system object whose access is managed by the system. |"},"err_msg":{"type":"string","description":"Error message."},"err_extra":{"type":"string","nullable":true,"description":"Additional information about the error, if any."}}}}}}}}
```

## Grant, change, or revoke access to an object

> Sets the role of one or more principals on a single object. A principal is a user, a user group, or an API key principal.\
> \
> Only the principals listed in \`access\_entries\` are changed. Principals that are not listed keep their current role.\
> \
> \- To grant or change access, set \`role\` to \`Viewer\` or \`Editor\`.\
> \- To revoke access, set \`role\` to \`None\`.\
> \
> You cannot use this endpoint to change the owner. If any entry refers to the current owner, the request fails with \`ACL\_PAPI\_005\` and no changes are applied. To transfer ownership, use \*\*Change the owner of an object\*\*.\
> \
> Every principal must be eligible to access the object type, for example its role must grant access to the relevant feature. Otherwise the request fails with \`ACL\_PAPI\_002\`.\
> \
> The calling API key must have permission to view and share the object. Whether owners and editors can share depends on the granular access settings of the tenant.\
> \
> \*\*Required license:\*\* Cortex XDR.

```json
{"openapi":"3.0.2","info":{"title":"Cortex XDR IAM APIs","version":"Cortex XDR 6.0"},"tags":[{"name":"Objects","description":"Operations for managing who can access objects such as dashboards, report templates, scripts, playbooks, and saved queries."}],"servers":[{"url":"https://api-{fqdn}","variables":{"fqdn":{"default":"cortex.paloaltonetworks.com","description":"The Fully Qualified Domain Name for the Cortex instance"}}}],"paths":{"/public_api/v1/object/update_access_entries":{"post":{"tags":["Objects"],"summary":"Grant, change, or revoke access to an object","description":"Sets the role of one or more principals on a single object. A principal is a user, a user group, or an API key principal.\n\nOnly the principals listed in `access_entries` are changed. Principals that are not listed keep their current role.\n\n- To grant or change access, set `role` to `Viewer` or `Editor`.\n- To revoke access, set `role` to `None`.\n\nYou cannot use this endpoint to change the owner. If any entry refers to the current owner, the request fails with `ACL_PAPI_005` and no changes are applied. To transfer ownership, use **Change the owner of an object**.\n\nEvery principal must be eligible to access the object type, for example its role must grant access to the relevant feature. Otherwise the request fails with `ACL_PAPI_002`.\n\nThe calling API key must have permission to view and share the object. Whether owners and editors can share depends on the granular access settings of the tenant.\n\n**Required license:** Cortex XDR.","operationId":"updateObjectAccessEntries","parameters":[{"name":"Authorization","in":"header","description":"{api_key}","required":true,"schema":{"type":"string"}},{"name":"x-xdr-auth-id","in":"header","description":"{api_key_id}","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Identifies the object and the change to apply. Send the fields at the top level of the body; do not wrap them in `request_data`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AclObjectUpdateAccessEntriesRequest"}}}},"responses":{"200":{"description":"The request succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AclObjectStatusResponse"}}}},"400":{"description":"Bad request. The request body is invalid, for example a required field is missing, an unknown field is present, or `object_type` is not supported. Also returned when an entry refers to the current owner of the object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AclObjectErrorResponse"}}}},"401":{"description":"Unauthorized access. The calling API key or its ID is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AclObjectErrorResponse"}}}},"403":{"description":"Forbidden. The calling API key cannot share the object, a principal is not eligible to access the object type, or the object is a system object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AclObjectErrorResponse"}}}},"404":{"description":"Not found. No object of the specified type exists with the specified ID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AclObjectErrorResponse"}}}},"500":{"description":"Internal server error. An unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AclObjectErrorResponse"}}}}}}}},"components":{"schemas":{"AclObjectUpdateAccessEntriesRequest":{"type":"object","description":"Request body for changing the access entries of an object.","additionalProperties":false,"required":["object_type","object_id","access_entries"],"properties":{"object_type":{"type":"string","description":"Type of the object. The value is case-insensitive.\n\n- `dashboards`: Dashboards.\n- `report_templates`: Report templates.\n- `scripts`: Automation scripts.\n- `playbooks`: Playbooks.\n- `xql_library`: Saved queries in the Query Library.","enum":["dashboards","report_templates","scripts","playbooks","xql_library"]},"object_id":{"type":"string","minLength":1,"description":"Unique identifier of the object, as a string. For example, `\"60\"` for a dashboard.\n\n- Report templates: You can display the template ID by adding the ID column to the report templates table in the UI.\n- Playbooks and scripts: Use the `id` field of the playbook or script."},"access_entries":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/AclObjectAccessEntryUpdate"},"description":"Role changes to apply. Principals that are not listed keep their current role."}}},"AclObjectAccessEntryUpdate":{"type":"object","description":"A role change for a single principal.","additionalProperties":false,"required":["principal_id","principal_type","role"],"properties":{"principal_id":{"type":"string","minLength":1,"description":"Identifier of the principal. The format depends on `principal_type`:\n\n- `User`: The user's email address, as returned in `user_email` by **List all users**.\n- `User Group`: The user group ID, as returned in `group_id` by **List all user groups**.\n- `API Key`: The numeric ID of the API key principal, as a string, as returned in `id` by [Get existing API Keys](https://app.gitbook.com/s/FK89utN7l3ilSek2DmU5/cortex-platform/api-keys) in the Cortex Platform APIs. This is the API key that has access to the object, not the calling API key."},"principal_type":{"type":"string","enum":["User","User Group","API Key"],"description":"Type of the principal. `API Key` refers to an API key principal, an API key that has access to the object. It does not refer to the calling API key."},"role":{"type":"string","enum":["Viewer","Editor","None"],"description":"Role to assign. Use `None` to revoke the principal's access. `Owner` is not allowed; use **Change the owner of an object** to transfer ownership."}}},"AclObjectStatusResponse":{"type":"object","description":"Result of the operation.","properties":{"reply":{"type":"object","description":"Result of the operation.","required":["status"],"properties":{"status":{"type":"string","enum":["Success"],"description":"Always `Success` when the request succeeds."}}}}},"AclObjectErrorResponse":{"type":"object","description":"Error returned by the object access control APIs.","properties":{"reply":{"type":"object","description":"Error details.","properties":{"err_code":{"type":"string","description":"Error code. Codes specific to these APIs:\n\n| Code | HTTP status | Meaning |\n|---|---|---|\n| `ACL_PAPI_001` | 404 | The object was not found. |\n| `ACL_PAPI_002` | 403 | The calling API key does not have permission to perform this action on the object, or a principal is not eligible to access the object type. |\n| `ACL_PAPI_003` | 500 | The change could not be applied. |\n| `ACL_PAPI_004` | 403 | Ownership of system objects cannot be transferred. |\n| `ACL_PAPI_005` | 400 | The owner's access cannot be changed with **Grant, change, or revoke access to an object**. |\n| `ACL_PAPI_006` | 400 | The specified user cannot own the object. |\n| `ACL_PAPI_007` | 403 | The object is a system object whose access is managed by the system. |"},"err_msg":{"type":"string","description":"Error message."},"err_extra":{"type":"string","nullable":true,"description":"Additional information about the error, if any."}}}}}}}}
```

## Change the owner of an object

> Transfers ownership of a single object to a user.\
> \
> \- You can transfer ownership only to a user, not to a user group or an API key principal.\
> \- The user must be eligible to own this object type, for example their role must grant access to the relevant feature.\
> \- The previous owner loses the Owner role and keeps no access to the object unless it was shared with them separately, for example through a user group. This matches the behavior in the UI.\
> \- If the user is already the owner, the request succeeds and nothing changes.\
> \- You cannot transfer ownership of system objects.\
> \
> The calling API key must have an administrator role.\
> \
> \*\*Required license:\*\* Cortex XDR.

```json
{"openapi":"3.0.2","info":{"title":"Cortex XDR IAM APIs","version":"Cortex XDR 6.0"},"tags":[{"name":"Objects","description":"Operations for managing who can access objects such as dashboards, report templates, scripts, playbooks, and saved queries."}],"servers":[{"url":"https://api-{fqdn}","variables":{"fqdn":{"default":"cortex.paloaltonetworks.com","description":"The Fully Qualified Domain Name for the Cortex instance"}}}],"paths":{"/public_api/v1/object/change_ownership":{"post":{"tags":["Objects"],"summary":"Change the owner of an object","description":"Transfers ownership of a single object to a user.\n\n- You can transfer ownership only to a user, not to a user group or an API key principal.\n- The user must be eligible to own this object type, for example their role must grant access to the relevant feature.\n- The previous owner loses the Owner role and keeps no access to the object unless it was shared with them separately, for example through a user group. This matches the behavior in the UI.\n- If the user is already the owner, the request succeeds and nothing changes.\n- You cannot transfer ownership of system objects.\n\nThe calling API key must have an administrator role.\n\n**Required license:** Cortex XDR.","operationId":"changeObjectOwnership","parameters":[{"name":"Authorization","in":"header","description":"{api_key}","required":true,"schema":{"type":"string"}},{"name":"x-xdr-auth-id","in":"header","description":"{api_key_id}","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Identifies the object and the change to apply. Send the fields at the top level of the body; do not wrap them in `request_data`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AclObjectChangeOwnershipRequest"}}}},"responses":{"200":{"description":"The request succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AclObjectStatusResponse"}}}},"400":{"description":"Bad request. The request body is invalid, for example a required field is missing, an unknown field is present, or `object_type` is not supported. Also returned when the specified user cannot own the object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AclObjectErrorResponse"}}}},"401":{"description":"Unauthorized access. The calling API key or its ID is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AclObjectErrorResponse"}}}},"403":{"description":"Forbidden. The calling API key does not have an administrator role, or the object is a system object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AclObjectErrorResponse"}}}},"404":{"description":"Not found. No object of the specified type exists with the specified ID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AclObjectErrorResponse"}}}},"500":{"description":"Internal server error. The ownership transfer could not be applied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AclObjectErrorResponse"}}}}}}}},"components":{"schemas":{"AclObjectChangeOwnershipRequest":{"type":"object","description":"Request body for changing the owner of an object.","additionalProperties":false,"required":["object_type","object_id","user_id"],"properties":{"object_type":{"type":"string","description":"Type of the object. The value is case-insensitive.\n\n- `dashboards`: Dashboards.\n- `report_templates`: Report templates.\n- `scripts`: Automation scripts.\n- `playbooks`: Playbooks.\n- `xql_library`: Saved queries in the Query Library.","enum":["dashboards","report_templates","scripts","playbooks","xql_library"]},"object_id":{"type":"string","minLength":1,"description":"Unique identifier of the object, as a string. For example, `\"60\"` for a dashboard.\n\n- Report templates: You can display the template ID by adding the ID column to the report templates table in the UI.\n- Playbooks and scripts: Use the `id` field of the playbook or script."},"user_id":{"type":"string","minLength":1,"description":"Email address of the user who becomes the owner."}}},"AclObjectStatusResponse":{"type":"object","description":"Result of the operation.","properties":{"reply":{"type":"object","description":"Result of the operation.","required":["status"],"properties":{"status":{"type":"string","enum":["Success"],"description":"Always `Success` when the request succeeds."}}}}},"AclObjectErrorResponse":{"type":"object","description":"Error returned by the object access control APIs.","properties":{"reply":{"type":"object","description":"Error details.","properties":{"err_code":{"type":"string","description":"Error code. Codes specific to these APIs:\n\n| Code | HTTP status | Meaning |\n|---|---|---|\n| `ACL_PAPI_001` | 404 | The object was not found. |\n| `ACL_PAPI_002` | 403 | The calling API key does not have permission to perform this action on the object, or a principal is not eligible to access the object type. |\n| `ACL_PAPI_003` | 500 | The change could not be applied. |\n| `ACL_PAPI_004` | 403 | Ownership of system objects cannot be transferred. |\n| `ACL_PAPI_005` | 400 | The owner's access cannot be changed with **Grant, change, or revoke access to an object**. |\n| `ACL_PAPI_006` | 400 | The specified user cannot own the object. |\n| `ACL_PAPI_007` | 403 | The object is a system object whose access is managed by the system. |"},"err_msg":{"type":"string","description":"Error message."},"err_extra":{"type":"string","nullable":true,"description":"Additional information about the error, if any."}}}}}}}}
```


---

# 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://cortex-docs.paloaltonetworks.com/xdr-api/identity-and-access-management-iam/objects.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.
