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 Credential Management API

APIs for Credential Management.

Palo Alto Networks Credential Management 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 Credential Management. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 14 operations across 7 paths, and defines 77 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.strata.paloaltonetworks.com/ngts.

14 operations 7 paths 77 schemas 3 DELETE4 GET5 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://{firewall}/api/
Authentication
OAuth 2.0, HTTP Bearer
License
Resource Areas
1

Authentication & Security 2

Palo Alto Networks Credential Management API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (scmOAuth) using the clientCredentials flow. It accepts HTTP bearer tokens (JWT) (scmToken). By default, every request must be authenticated.

  • scmOAuth — Strata Cloud Manager APIs authenticate client requests using the OAuth 2.0 Client Credentials flow. Please use the clientid, clientsecret values associated wit…
  • scmToken — Strata Cloud Manager APIs authenticate client requests using the OAuth 2.0 Client Credentials flow. Please use the clientid, clientsecret values associated wit…

Paths & Operations 14

Across 7 paths, the API surfaces 14 operations — 3 DELETE, 4 GET, 5 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Credential Management 14

APIs for Credential Management.

GET
/v1/credentialmanagerconfigurations
Retrieves a set of Credential Manager
get-public-cms-conf 1 param → 200400401403404500
POST
/v1/credentialmanagerconfigurations
Add a set of Credential Manager
post-public-cms-conf body → 201400401403404500
PUT
/v1/credentialmanagerconfigurations
Update a Credential Manager Service configuration
put-public-cms-conf body → 200400401403404500
GET
/v1/credentialmanagerconfigurations/{id}
Retrieves a Credential Manager Service configurati
get-public-cms-conf-id 1 param → 200400401403404500
DELETE
/v1/credentialmanagerconfigurations/{id}
Delete a Credential Manager Service configuration
delete-public-cms-conf-id 1 param → 204400401403404500
POST
/v1/credentialmanagerconfigurations/test
Test the connection to a privileged
post-public-cms-conf-test body → 200400401403404500
POST
/v1/credentialmanagerconfigurations/{id}/test
Test the connection to an external
post-public-cms-conf-test-id 1 param → 200400401403404500
GET
/v1/credentials
Retrieves credentials for a company
get-public-cms-credential 5 params → 200400401403422500
POST
/v1/credentials
Add a set of new shared
post-public-cms-credential body → 201400401403422500
PUT
/v1/credentials
Update a shared credential
put-public-cms-credential body → 200400401403422500
DELETE
/v1/credentials
Delete shared credentials
delete-public-cms-credential 1 param → 200400401403422500
GET
/v1/credentials/{id}
Retrieves shared credential by ID
get-public-cms-credential-id 2 params → 200400401403422500
DELETE
/v1/credentials/{id}
Delete shared credential by ID
delete-public-cms-credential-id 1 param → 204400401403422500
POST
/v1/credentials/test
Test the access to shared credential
post-public-cms-credential-test-id body → 200400401403404500

Schemas 77

The contract defines 77 schemas that model the data the API accepts and returns. The most detailed are CredentialResponse (13 properties), CMSConfigurationResponse (12 properties), AddCredentialRequest (6 properties), CreateCMSConfigurationRequest (6 properties). Each schema is shown below with its type and property counts.

TokenAuthenticationData
object
1 property
TestCredentialResponse
object
The result of testing access to the credential.
2 properties 2 required
TestCredentialRequest
object
The properties representing a credential to test.
5 properties 1 required
ResponseHashiCorpCredDetails
CyberArkDetails
object
The CyberArk Credential information.
3 properties
CertificateCredentialData
object
4 properties
TeamsIds
array
The ID's of teams.
ErrorResponse10
object
Holds the response body returned for errors.
1 property
UpdateHashiCorpCredDetails
ResponseCredentialDetails
Error
object
Hold the error details.
3 properties 2 required
ResponseCMSDetails
An string containing the JSON content representing the details of the specific privileged access management.
CreatedBy
string
The ID of the user whom created the credential.
HashiCorpDetailsRequiredProp
2 required
TestCyberArkCredDetails
HashiCorpConfigurationRequiredProp
The configuration for the HashiCorp app. It's required to set the value for the cmsType property to hashicorp.
1 required
AuthType
string
The type of the authentication: password usernamepassword
CMSConfigurationResponse
object
The information representing a Credential Manager Service configuration for response.
12 properties
CyberArkConfigurationRequiredProp
The configuration for the CyberArk app. It's required to set the value for the cmsType property to cyberark.
2 required
TestCyberArkDetails
UpdateCredentialDetails
TestCredentialDetails
CyberArkDetailsRequiredProp
2 required
CMSConfId
string
The Credential Manager Service configuration ID.
TeamId
string
The ID of a team.
CreateCyberArkDetails
References
array
The machines referenced.
UpdateCredentialRequest
object
The properties representing a credential to update.
5 properties 1 required
CMSAuthenticationType
string
The authentication type for the privileged access management: certificate - For authentication with a Certificate bundle userPassword - For authentication with…
ResponseCyberArkCredDetails
CreatedOn
string
The date in ISO 8601 full-date format when the credential was created.
CyberArkConfiguration
The configuration for the CyberArk app. It's required to set the value for the cmsType property to cyberark.
UpdateCMSDetails
ResponseCyberArkDetails
ResponseHashiCorpDetails
CreateCMSConfigurationsRequest
object
The array of Credential Manager Service configurations to create.
1 property 1 required
VSatelliteId
string
The VSatellite ID
AddCredentialsRequest
object
Array of credentials to add.
1 property 1 required
Name
string
The Name of CMS configuration
HashiCorpDetails
object
The HashiCorp Credential information.
2 properties
UserPasswordAuthenticationData
object
2 properties
CredentialResponse
object
The properties representing a Credential for response purposes.
13 properties 5 required
UpdateCyberArkDetails
CreateCredentialDetails
Reference
object
The machine referenced.
2 properties 2 required
AppId
string
The application ID from the CyberArk provider.
TestCMSDetails
HashiCorpConfiguration
The configuration for the HashiCorp app. It's required to set the value for the cmsType property to hashicorp.
AppRoleAuthenticationData
object
2 properties
CreateHashiCorpCredDetails
TestCMSConfigurationResponse
object
The result of testing the Credential Manager Service configuration.
2 properties 2 required
AddCredentialRequest
object
The properties representing a credential to add.
6 properties 4 required
UpdateCMSConfigurationRequest
object
The information representing a Credential Manager Service configuration for update.
6 properties 1 required
LastModifiedOn
string
The date in ISO 8601 full-date format when the credential was modified.
CreateHashiCorpDetails
UpdateCyberArkCredDetails
LastModifiedBy
string
The ID of the user whom modified the credential.
TestCMSConfigurationRequest
object
The information representing a Credential Manager Service configuration for test purposes.
6 properties 1 required
DeleteCredentialsResponse
object
The response for the delete credentials action.
2 properties 2 required
CreateCyberArkCredDetails
CredentialId
string
The ID of the Credential in our System.
VSatelliteIds
array
An array of the VSatellite Ids which are connected to the CMS provider.
CreateCMSDetails
CreateCMSConfigurationRequest
object
The information representing a Credential Manager Service configuration for creation purpose.
6 properties 3 required
CompanyId
string
The company ID
CredentialName
string
The name of the Credential in our System.
TestHashiCorpCredDetails
CMSURL
string
The baseUrl of the privileged access management provider.
CMSType
string
The type of the privileged access management: cyberark - For CyberArk privileged access management hashicorp - For HashiCorp privileged access management
UpdateHashiCorpDetails
AddCredentialsResponse
object
The response for the add credentials action.
2 properties 2 required
TestHashiCorpDetails
GetCMSConfigurationsResponse
object
The array of Credential Manager Service configurations received.
2 properties 2 required
GetCredentialsResponse
object
Array of credentials received.
2 properties 2 required
TSGId
string
The TSG identifier the credential belongs to.
ReferenceType
string
The type of the reference: machine
CreateCMSConfigurationsResponse
object
The array of Credential Manager Service configurations created.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

palo-alto-networks-credential-management-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 Credential Management 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.