How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Palo Alto Networks IAM API

Prisma Cloud identity and access management (IAM) security provides:* Visiblity—Query all relevant IAM entities* Gonvernance—Monitor your cloud environment for overly-used permissions* Response—Automatically remediate permissionsThe IAM security endpoints enable you to investigate IAM data programmatically.See [Primsa Cloud IAM Security](https://docs.paloaltonetworks.com/prisma/prisma-cloud/prisma-cloud-admin/prisma-cloud-iam-security/what-is-prisma-cloud-iam-security.html)for more information.### Error HandlingLike other Prisma Cloud public API requests, the IAM security API requests return standard HTTP response codes. Unlike most other CSPM API error handling, IAM security API error responses do not include an [x-redlock-status](//prisma-cloud/api/cspm/api-errors)in the response header.### PaginationYou can control the number of items in a response for endpoints that support pagination. Use request parameter **limit** to control the maximum number of items in a response. If the response includes**data.nextPageToken**, use **data.nextPageToken** as the request parameter **pageToken** in a request forthe next page of data. The following table summarizes the request parameters for pagination:Request Parameter | Description -----------| -------**limit** | Maximum number of items to return in a page.**pageToken** | Use the **data.nextPageToken** value from the previous response object to return the next page of data.

Palo Alto Networks IAM API is one of 741 APIs that Palo Alto Networks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include IAM. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 21 operations across 21 paths, and defines 48 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 15 base URLs: https://api.prismacloud.io, https://api2.prismacloud.io, https://api3.prismacloud.io, https://api4.prismacloud.io, https://api.anz.prismacloud.io, https://api.eu.prismacloud.io, https://api2.eu.prismacloud.io, https://api.gov.prismacloud.io, https://api.prismacloud.cn, https://api.ca.prismacloud.io, https://api.sg.prismacloud.io, https://api.uk.prismacloud.io, https://api.ind.prismacloud.io, https://api.jp.prismacloud.io, https://api.fr.prismacloud.io.

21 operations 21 paths 48 schemas 9 GET12 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://{firewall}/api/
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Palo Alto Networks IAM API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-redlock-auth (x-redlock-auth).

  • x-redlock-auth — The x-redlock-auth value is a JSON Web Token (JWT).

Paths & Operations 21

Across 21 paths, the API surfaces 21 operations — 9 GET, 12 POST. Each is listed below with its method, path, parameters, and response codes.

IAM 21

Prisma Cloud identity and access management (IAM) security provides: Visiblity—Query all relevant IAM entities Gonvernance—Monitor your cloud environment for overly-used permissio…

POST
/api/v1/permission
Get Permissions
get-permissions-with-post body → 200201401403404
POST
/api/v1/permission/page
Get Permissions Next Page
get-next-permissions-page-with-post body → 200201401403404
POST
/api/v1/permission/access
Get Permissions Access
get-permissions-access-with-post body → 200201401403404
POST
/api/v1/permission/access/page
Get Permissions Access Next Page
get-next-permissions-access-with-post body → 200201401403404
POST
/api/v1/permission/alert/remediation
Get Remediation
get-remediation-with-post body → 200201401403404
GET
/api/v1/permission/alert/search
Get IAM Query
get-rql-with-get 1 param → 200401403404
POST
/api/v1/suggest
Get Query Suggestions
get-suggestions-with-post body → 200201401403404
POST
/iam/api/v3/search/permission
Get Permissions V3
search-permissions-v3 1 param body → 200400401403404429
POST
/iam/api/v4/search/permission
Get Permissions V4
permission-search-v4 1 param body → 200400401403404429
POST
/iam/api/v3/permission/{permission-id}/list_access
Get Permission Accesses V3
permissions-accesses-v3 2 params body → 200400401403404429
POST
/iam/api/v2/suggestion
Get Query Suggestions V2
iam-suggest-v2 body → 200400401403404429
POST
/iam/api/v2/search/iam_config
Get Permissions Role or Policy Definition V2
permission-raw-config-definition body → 200400401403404429
POST
/iam/api/v1/asset/{asset-id}/related-asset
Get Cloud Identity Inventory (CII) Resource Related Assets
cii-related-assets-v1 2 params body → 200400401403404429
GET
/iam/api/v2/alert/{alertId}/remediation_command
Get Remediation Command
alert-remediation-command 1 param → 200400401403404429
GET
/iam/api/v2/alert/{alertId}/query
Get IAM Query V2
investigate-alert 1 param → 200400401403404429
GET
/iam/api/v1/assets/{assetId}/over-permissive-metadata
Get Least Privilege Access Metadata of an Asset
least-privilege-access-metadata-v1 1 param → 200400401403404429
GET
/iam/api/v1/assets/{assetId}/existing-least-privileged-access
Get Existing Least Privilege Access Suggestions for an Asset
existing-least-privilege-access-v1 3 params → 200400401403404429
GET
/iam/api/v1/assets/{assetId}/custom-least-privileged-access
Get New Least Privilege Access Suggestions for an Asset
custom-least-privilege-access-v1 3 params → 200400401403404429
GET
/iam/api/v1/resources/{resourceId}/over-permissive-metadata
Get Least Privilege Access Metadata of a Resource
least-privilege-access-metadata-by-resource-v1 1 param → 200400401403404429
GET
/iam/api/v1/resources/{resourceId}/existing-least-privileged-access
Get Least Privilege Access Suggestions for a Resource
existing-least-privilege-access-by-resource-v1 3 params → 200400401403404429
GET
/iam/api/v1/resources/{resourceId}/custom-least-privileged-access
Get New Least Privilege Access Suggestions for a Resource
custom-least-privilege-access-by-resource-v1 3 params → 200400401403404429

Schemas 48

The contract defines 48 schemas that model the data the API accepts and returns. The most detailed are PermissionDto_2 (49 properties), PermissionV4DataItemDto (46 properties), PermissionDto (38 properties), PermissionSearchV4ResponseDto (9 properties). Each schema is shown below with its type and property counts.

RemediationRequestDto
object
Model for Remediation Request DTO
1 property 1 required
SuggestResponseDto
object
Model for Suggest Response DTO
5 properties
PermissionDto
object
Model for Permission DTO
38 properties
TimeRangeDto
object
Model for Time Range DTO
2 properties
RemediationResponseDto
object
Model for Remediation Response DTO
2 properties
PermissionSearchResponseDto
object
Model for Permission Search Response DTO
8 properties
PermissionExceptionDto
object
Model for Permission Exception DTO
1 property
PermissionSearchPageRequestDto
object
Model for Permission Search Page Request DTO
2 properties
SuggestRequestDto
object
Model for Suggest Request DTO
1 property 1 required
PermissionSearchResultDataDto
object
Model for Permission Search Result Data DTO
4 properties
PermissionAccessRequestDto
object
Model for Permission Access Request DTO
3 properties 2 required
PermissionAccessResultDataDto
object
Model for Permission Access Result Data DTO
3 properties
PermissionAccessPageRequestDto
object
Model for Permission Access Page Request DTO
2 properties
RqlResponseDto
object
Model for RQL Response DTO
3 properties
PermissionAccessResponseDto
object
Model for Permission Access Response DTO
1 property
PermissionLastAccessDto
object
Model for Permission Last Access DTO
2 properties
PermissionSearchRequestDto
object
Model for Permission Search Request DTO
3 properties 2 required
TimeRangeDto_2
object
The time range which the query run at to generate the alert
1 property 1 required
PermissionAccessRequestDtoV3
object
2 properties 1 required
PermissionRawDataResponseDto
object
1 property
PermissionAccessResponseDtoV3
object
1 property
PermissionAccessResultDataDtoV3
object
Permissions last access list
3 properties
ExistingLeastPrivilegedAccessResponseDto
object
5 properties
CloudAssetRelatedAssetsRequestDto
object
4 properties
PermissionSearchV4RequestDto
object
4 properties 1 required
RemediationResponseDtoV2
object
2 properties
ExistingLeastPrivilegedAccessDto
object
Least Privileged Access items
5 properties
PermissionSearchV4ResponseDto
object
9 properties
PermissionLastAccessDto_2
object
items list
4 properties
SuggestResponseDto_2
object
5 properties
PermissionDto_2
object
items list
49 properties
PermissionExceptionDto_2
object
Permission exception list
1 property
PermissionV4DataItemDto
object
items list
46 properties
CustomLeastPrivilegedAccessDto
object
Least Privileged Access items
2 properties
SuggestRequestDto_2
object
1 property
CloudAssetRelatedAssetsResponseDto
object
3 properties
CustomLeastPrivilegedAccessResponseDto
object
5 properties
PermissionSearchResponseDtoV3
object
9 properties
OverPermissiveMetadataResponseDto
object
5 properties
RqlResponseDtoV2
object
2 properties
PermissionRawDataRequestDto
object
1 property
PermissionSearchResultDataDtoV3
object
4 properties
LeastPrivilegedPermissionVerdict
object
Least Privileged result analysis
3 properties
ApiErrorResponseBodyDto
object
5 properties 2 required
CloudAssetRelatedAssetDto
object
items list
7 properties
ApiErrorResponseDto
object
1 property
PermissionSearchRequestDtoV3
object
3 properties 1 required
PermissionSearchV4ResponseDataDto
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

palo-alto-networks-iam-api-openapi.yml Raw ↑

Other APIs Palo Alto Networks publishes across the network.

PAN-OS XML API
PAN-OS OpenConfig API
Panorama API
AutoFocus API (Deprecated)
Prisma SASE Service Status API
Cross-Platform Service Status API
SASE Authentication Service API
Expedition API (Deprecated)
VM-Series Licensing API
Palo Alto Networks 5G Deregistered Trend API
Palo Alto Networks 5G Network Interconnects and Bandwidth API
Palo Alto Networks 5G Registered Trend API
Where this information came from

This is an independent, third-party profile of Palo Alto Networks IAM API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.