Palo Alto Networks Credential Management API
APIs for Credential Management.
APIs for Credential Management.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/palo-alto-networks-credential-management-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: TLS Protect Cloud API for Strata Cloud Manager Credential Management API
description: Use the TLS Protect Cloud APIs to manage certificates, certificate requests, applications, machine identities, users, teams, event logs, and more. This Open API spec file was created on June 04, 2026. © 2026 Palo Alto Networks, Inc. Palo Alto Networks is a registered trademark of Palo Alto Networks. A list of our trademarks can be found at https://www.paloaltonetworks.com/company/trademarks.html. All other marks mentioned herein may be trademarks of their respective companies.
version: 1.0.0
license:
name: MIT
url: https://opensource.org/license/mit
servers:
- url: https://api.strata.paloaltonetworks.com/ngts
description: Strata Cloud Manager API
security:
- scmToken: []
tags:
- name: Credential Management
description: APIs for Credential Management.
paths:
/v1/credentialmanagerconfigurations:
get:
description: Retrieves a set of stored Credential Manager Service configurations.
operationId: get-public-cms-conf
parameters:
- $ref: '#/components/parameters/CMSTypesParam'
responses:
'200':
$ref: '#/components/responses/200GetCMSConfigurations'
'400':
$ref: '#/components/responses/400BadRequest'
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
'500':
$ref: '#/components/responses/500InternalServerErrorContent'
summary: Retrieves a set of Credential Manager
tags:
- Credential Management
post:
description: Adds a set of new Credential Manager Service configurations. Only one Credential Manager Service configuration per `cmsType` per company can exist.
operationId: post-public-cms-conf
requestBody:
$ref: '#/components/requestBodies/CreateCMSConfigurationsBodyRequest'
responses:
'201':
$ref: '#/components/responses/201CreateCMSConfigurations'
'400':
$ref: '#/components/responses/400BadRequest'
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
'500':
$ref: '#/components/responses/500InternalServerErrorContent'
summary: Add a set of Credential Manager
tags:
- Credential Management
put:
description: Updates the information of an existing Credential Manager Service configuration.
operationId: put-public-cms-conf
requestBody:
$ref: '#/components/requestBodies/UpdateCMSConfigurationsBodyRequest'
responses:
'200':
$ref: '#/components/responses/200UpdateCMSConfiguration'
'400':
$ref: '#/components/responses/400BadRequest'
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
'500':
$ref: '#/components/responses/500InternalServerErrorContent'
summary: Update a Credential Manager Service configuration
tags:
- Credential Management
/v1/credentialmanagerconfigurations/{id}:
get:
description: Retrieves a Credential Manager Service configuration by the specified `id`.
operationId: get-public-cms-conf-id
responses:
'200':
$ref: '#/components/responses/200GetCMSConfiguration'
'400':
$ref: '#/components/responses/400BadRequest'
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
'500':
$ref: '#/components/responses/500InternalServerErrorContent'
summary: Retrieves a Credential Manager Service configurati
tags:
- Credential Management
parameters:
- $ref: '#/components/parameters/CMSConfigIdParam'
delete:
description: Deletes a Credential Manager Service configuration by the specified `id`.
operationId: delete-public-cms-conf-id
responses:
'204':
description: The returned HTTP code if the Credential Manager Service configuration was deleted successfully.
'400':
$ref: '#/components/responses/400BadRequest'
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
'500':
$ref: '#/components/responses/500InternalServerErrorContent'
summary: Delete a Credential Manager Service configuration
tags:
- Credential Management
parameters:
- $ref: '#/components/parameters/CMSConfigIdParam'
/v1/credentialmanagerconfigurations/test:
post:
description: Tests the connection to a configured privileged access management through selected VSatellites.
operationId: post-public-cms-conf-test
requestBody:
$ref: '#/components/requestBodies/TestCMSConfigurationBodyRequest'
responses:
'200':
$ref: '#/components/responses/200TestCMSConfiguration'
'400':
$ref: '#/components/responses/400BadRequest'
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
'500':
$ref: '#/components/responses/500InternalServerErrorContent'
summary: Test the connection to a privileged
tags:
- Credential Management
/v1/credentialmanagerconfigurations/{id}/test:
post:
description: Tests the connection to a configured privileged access management through selected VSatellites using a specified `id`.
operationId: post-public-cms-conf-test-id
responses:
'200':
$ref: '#/components/responses/200TestCMSConfiguration'
'400':
$ref: '#/components/responses/400BadRequest'
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
'500':
$ref: '#/components/responses/500InternalServerErrorContent'
summary: Test the connection to an external
tags:
- Credential Management
parameters:
- $ref: '#/components/parameters/CMSConfigIdParam'
/v1/credentials:
get:
description: Retrieves a list of shared credentials for a company.
operationId: get-public-cms-credential
parameters:
- $ref: '#/components/parameters/CMSCredentialDetailsParam'
- $ref: '#/components/parameters/CMSTypesParam'
- $ref: '#/components/parameters/CredentialIdsParam'
- $ref: '#/components/parameters/TeamIdsParam'
- $ref: '#/components/parameters/AuthTypesParam'
responses:
'200':
$ref: '#/components/responses/200GetCredentials'
'400':
$ref: '#/components/responses/400BadRequest'
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'422':
$ref: '#/components/responses/404NotFound'
'500':
$ref: '#/components/responses/500InternalServerErrorContent'
summary: Retrieves credentials for a company
tags:
- Credential Management
post:
description: Adds a set of new shared credentials. The `name` for each credential must be unique.
operationId: post-public-cms-credential
requestBody:
$ref: '#/components/requestBodies/AddCredentialsBodyRequest'
responses:
'201':
$ref: '#/components/responses/201AddCredentials'
'400':
$ref: '#/components/responses/400BadRequest'
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'422':
$ref: '#/components/responses/404NotFound'
'500':
$ref: '#/components/responses/500InternalServerErrorContent'
summary: Add a set of new shared
tags:
- Credential Management
put:
description: Updates the information of an existing shared credential.
operationId: put-public-cms-credential
requestBody:
$ref: '#/components/requestBodies/UpdateCredentialBodyRequest'
responses:
'200':
$ref: '#/components/responses/200UpdateCredential'
'400':
$ref: '#/components/responses/400BadRequest'
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'422':
$ref: '#/components/responses/404NotFound'
'500':
$ref: '#/components/responses/500InternalServerErrorContent'
summary: Update a shared credential
tags:
- Credential Management
delete:
description: Deletes existing shared credentials specified in the query parameter list of `ids`.
operationId: delete-public-cms-credential
parameters:
- $ref: '#/components/parameters/CredentialIdsParam'
responses:
'200':
$ref: '#/components/responses/200DeleteCredentials'
'400':
$ref: '#/components/responses/400BadRequest'
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'422':
$ref: '#/components/responses/404NotFound'
'500':
$ref: '#/components/responses/500InternalServerErrorContent'
summary: Delete shared credentials
tags:
- Credential Management
/v1/credentials/{id}:
get:
description: Retrieves the credential matching with provided `id`.
operationId: get-public-cms-credential-id
parameters:
- name: id
in: path
required: true
description: Credential ID.
schema:
type: string
format: uuid
- $ref: '#/components/parameters/CMSCredentialDetailsParam'
responses:
'200':
$ref: '#/components/responses/200GetCredential'
'400':
$ref: '#/components/responses/400BadRequest'
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'422':
$ref: '#/components/responses/404NotFound'
'500':
$ref: '#/components/responses/500InternalServerErrorContent'
summary: Retrieves shared credential by ID
tags:
- Credential Management
delete:
description: Deletes the shared credential by the specified `id`.
operationId: delete-public-cms-credential-id
responses:
'204':
description: The returned http code if the credential was deleted successfully.
'400':
$ref: '#/components/responses/400BadRequest'
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'422':
$ref: '#/components/responses/404NotFound'
'500':
$ref: '#/components/responses/500InternalServerErrorContent'
summary: Delete shared credential by ID
tags:
- Credential Management
parameters:
- $ref: '#/components/parameters/CredentialIdParam'
/v1/credentials/test:
post:
description: Tests the access to a shared credential using a specified `id` or by providing credential values. If both an `id` and parameters are provided, parameters override existing credential values.
operationId: post-public-cms-credential-test-id
requestBody:
$ref: '#/components/requestBodies/TestCredentialBodyRequest'
responses:
'200':
$ref: '#/components/responses/200TestCredential'
'400':
$ref: '#/components/responses/400BadRequest'
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
'500':
$ref: '#/components/responses/500InternalServerErrorContent'
summary: Test the access to shared credential
tags:
- Credential Management
components:
parameters:
CredentialIdsParam:
description: The credential Ids separated by commas.
explode: false
in: query
name: ids
schema:
items:
$ref: '#/components/schemas/CredentialId'
minItems: 1
type: array
CMSTypesParam:
description: The privileged access management types separated by commas.
explode: false
in: query
name: cmsTypes
schema:
items:
$ref: '#/components/schemas/CMSType'
minItems: 1
type: array
CMSConfigIdParam:
description: The id of the Credential Manager Service configuration.
in: path
name: id
required: true
schema:
$ref: '#/components/schemas/CMSConfId'
TeamIdsParam:
description: The team Ids separated by commas.
explode: false
in: query
name: teamIds
schema:
items:
$ref: '#/components/schemas/TeamId'
minItems: 1
type: array
CredentialIdParam:
description: The credential Id.
in: path
name: id
required: true
schema:
$ref: '#/components/schemas/CredentialId'
CMSCredentialDetailsParam:
description: The option of whether or not return full credential details. Only Admin users can use this parameter.
in: query
name: details
schema:
type: boolean
AuthTypesParam:
description: The authentication types separated by commas.
explode: false
in: query
name: authTypes
schema:
items:
$ref: '#/components/schemas/AuthType'
minItems: 1
type: array
schemas:
AddCredentialRequest:
description: The properties representing a credential to add.
properties:
authType:
$ref: '#/components/schemas/AuthType'
cmsConfigId:
$ref: '#/components/schemas/CMSConfId'
cmsType:
$ref: '#/components/schemas/CMSType'
credentialDetails:
$ref: '#/components/schemas/CreateCredentialDetails'
name:
$ref: '#/components/schemas/CredentialName'
teamsIds:
$ref: '#/components/schemas/TeamsIds'
required:
- name
- cmsType
- authType
- credentialDetails
type: object
Name:
description: The Name of CMS configuration
type: string
LastModifiedOn:
description: The date in ISO 8601 full-date format when the credential was modified.
format: date
type: string
HashiCorpConfiguration:
allOf:
- properties:
authType:
$ref: '#/components/schemas/CMSAuthenticationType'
namespace:
description: The namespace in HashiCorp Vault to connect to.
type: string
url:
$ref: '#/components/schemas/CMSURL'
required:
- authType
type: object
- oneOf:
- $ref: '#/components/schemas/CertificateCredentialData'
- $ref: '#/components/schemas/UserPasswordAuthenticationData'
- $ref: '#/components/schemas/TokenAuthenticationData'
- $ref: '#/components/schemas/AppRoleAuthenticationData'
description: The configuration for the HashiCorp app. It's required to set the value for the `cmsType` property to `hashicorp`.
CreateHashiCorpDetails:
allOf:
- $ref: '#/components/schemas/HashiCorpConfigurationRequiredProp'
GetCredentialsResponse:
description: Array of credentials received.
properties:
count:
type: integer
credentials:
items:
$ref: '#/components/schemas/CredentialResponse'
type: array
required:
- credentials
- count
type: object
VSatelliteId:
description: The VSatellite ID
format: uuid
type: string
CyberArkConfiguration:
allOf:
- properties:
appID:
$ref: '#/components/schemas/AppId'
baseUrl:
$ref: '#/components/schemas/CMSURL'
type: object
- $ref: '#/components/schemas/CertificateCredentialData'
description: The configuration for the CyberArk app. It's required to set the value for the `cmsType` property to `cyberark`.
Error:
description: Hold the error details.
properties:
args:
description: List of arguments used to generate the error message.
items:
type: object
type: array
code:
description: The error code.
type: integer
message:
description: The error message.
type: string
required:
- code
- message
type: object
ResponseCMSDetails:
description: An string containing the JSON content representing the details of the specific privileged access management.
oneOf:
- $ref: '#/components/schemas/ResponseCyberArkDetails'
- $ref: '#/components/schemas/ResponseHashiCorpDetails'
TestCMSDetails:
oneOf:
- $ref: '#/components/schemas/TestCyberArkDetails'
- $ref: '#/components/schemas/TestHashiCorpDetails'
CMSType:
description: "The type of the privileged access management:\n * `cyberark` - For CyberArk privileged access management\n * `hashicorp` - For HashiCorp privileged access management\n"
enum:
- cyberark
- hashicorp
type: string
TeamId:
description: The ID of a team.
example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
format: uuid
type: string
TestCredentialRequest:
description: The properties representing a credential to test.
properties:
authType:
$ref: '#/components/schemas/AuthType'
cmsType:
$ref: '#/components/schemas/CMSType'
credentialDetails:
$ref: '#/components/schemas/TestCredentialDetails'
id:
$ref: '#/components/schemas/CredentialId'
wsClientId:
description: An ID where you can subscribe to receive the response of the workflow.
type: string
required:
- wsClientId
type: object
CreateHashiCorpCredDetails:
allOf:
- $ref: '#/components/schemas/HashiCorpDetailsRequiredProp'
ResponseCredentialDetails:
oneOf:
- $ref: '#/components/schemas/ResponseCyberArkCredDetails'
- $ref: '#/components/schemas/ResponseHashiCorpCredDetails'
HashiCorpConfigurationRequiredProp:
allOf:
- $ref: '#/components/schemas/HashiCorpConfiguration'
description: The configuration for the HashiCorp app. It's required to set the value for the `cmsType` property to `hashicorp`.
required:
- url
CredentialName:
description: The name of the Credential in our System.
type: string
TestHashiCorpDetails:
allOf:
- $ref: '#/components/schemas/HashiCorpConfigurationRequiredProp'
TestCredentialDetails:
oneOf:
- $ref: '#/components/schemas/TestCyberArkCredDetails'
- $ref: '#/components/schemas/TestHashiCorpCredDetails'
UpdateCyberArkDetails:
allOf:
- $ref: '#/components/schemas/CyberArkConfiguration'
CreateCyberArkCredDetails:
allOf:
- $ref: '#/components/schemas/CyberArkDetailsRequiredProp'
UpdateCredentialRequest:
description: The properties representing a credential to update.
properties:
cmsConfigId:
$ref: '#/components/schemas/CMSConfId'
credentialDetails:
$ref: '#/components/schemas/UpdateCredentialDetails'
id:
$ref: '#/components/schemas/CredentialId'
name:
$ref: '#/components/schemas/CredentialName'
teamsIds:
$ref: '#/components/schemas/TeamsIds'
required:
- id
type: object
CMSConfigurationResponse:
description: The information representing a Credential Manager Service configuration for response.
properties:
cmsDetails:
$ref: '#/components/schemas/ResponseCMSDetails'
cmsType:
$ref: '#/components/schemas/CMSType'
companyId:
$ref: '#/components/schemas/CompanyId'
consumerTsgIds:
description: List of sub-TSG IDs the configuration is explicitly shared with. Mutually exclusive with shareWithAll=true.
items:
type: string
type: array
createdBy:
$ref: '#/components/schemas/CreatedBy'
createdOn:
$ref: '#/components/schemas/CreatedOn'
id:
$ref: '#/components/schemas/CMSConfId'
lastModifiedBy:
$ref: '#/components/schemas/LastModifiedBy'
lastModifiedOn:
$ref: '#/components/schemas/LastModifiedOn'
name:
$ref: '#/components/schemas/Name'
shareWithAll:
description: When true, the configuration is shared with all sub-TSGs.
type: boolean
vSatelliteIds:
$ref: '#/components/schemas/VSatelliteIds'
type: object
CreateCMSConfigurationsRequest:
description: The array of Credential Manager Service configurations to create.
properties:
cmsConfigurations:
items:
$ref: '#/components/schemas/CreateCMSConfigurationRequest'
minItems: 1
type: array
required:
- cmsConfigurations
type: object
GetCMSConfigurationsResponse:
description: The array of Credential Manager Service configurations received.
properties:
cmsConfigurations:
items:
$ref: '#/components/schemas/CMSConfigurationResponse'
minItems: 1
type: array
count:
type: integer
required:
- cmsConfigurations
- count
type: object
CMSAuthenticationType:
description: "The authentication type for the privileged access management:\n * `certificate` - For authentication with a Certificate bundle\n * `userPassword` - For authentication with user and password\n * `token` - For authentication with token\n * `appRole` - For authentication with AppRole\n"
enum:
- certificate
- userPassword
- token
- appRole
type: string
DeleteCredentialsResponse:
description: The response for the delete credentials action.
properties:
count:
type: integer
idsCredentialsDeleted:
items:
$ref: '#/components/schemas/CredentialId'
minItems: 1
type: array
required:
- idsCredentialsDeleted
- count
type: object
UserPasswordAuthenticationData:
properties:
password:
description: The user's password of the underlying credentials provider.
format: password
type: string
userName:
description: The user's name of the underlying credentials provider.
type: string
type: object
ResponseHashiCorpCredDetails:
allOf:
- $ref: '#/components/schemas/HashiCorpDetailsRequiredProp'
References:
description: The machines referenced.
items:
$ref: '#/components/schemas/Reference'
type: array
uniqueItems: true
CreatedBy:
description: The ID of the user whom created the credential.
type: string
CredentialId:
description: The ID of the Credential in our System.
example: 94e86140-d85f-11ed-afa1-0242ac120002
format: uuid
type: string
AppRoleAuthenticationData:
properties:
roleId:
description: The Role ID used for authentication with the underlying credentials provider.
type: string
secretId:
description: The Secret ID used for authentication with the underlying credentials provider.
type: string
type: object
UpdateCyberArkCredDetails:
allOf:
- $ref: '#/components/schemas/CyberArkDetails'
UpdateCMSConfigurationRequest:
description: The information representing a Credential Manager Service configuration for update.
properties:
cmsDetails:
$ref: '#/components/schemas/UpdateCMSDetails'
consumerTsgIds:
description: List of sub-TSG IDs the configuration is explicitly shared with. Mutually exclusive with shareWithAll=true.
items:
type: string
type: array
id:
$ref: '#/components/schemas/CMSConfId'
name:
$ref: '#/components/schemas/Name'
shareWithAll:
description: When true, the configuration is shared with all sub-TSGs.
type: boolean
vSatelliteIds:
$ref: '#/components/schemas/VSatelliteIds'
required:
- id
type: object
HashiCorpDetails:
description: The HashiCorp Credential information.
properties:
secretKeyName:
description: The HashiCorp secret key name property.
type: string
secretPath:
description: The HashiCorp secret path property.
type: string
type: object
CredentialResponse:
description: The properties representing a Credential for response purposes.
properties:
authType:
$ref: '#/components/schemas/AuthType'
cmsConfigId:
$ref: '#/components/schemas/CMSConfId'
cmsType:
$ref: '#/components/schemas/CMSType'
createdBy:
$ref: '#/components/schemas/CreatedBy'
createdOn:
$ref: '#/components/schemas/CreatedOn'
credentialDetails:
$ref: '#/components/schemas/ResponseCredentialDetails'
id:
$ref: '#/components/schemas/CredentialId'
lastModifiedBy:
$ref: '#/components/schemas/LastModifiedBy'
lastModifiedOn:
$ref: '#/components/schemas/LastModifiedOn'
name:
$ref: '#/components/schemas/CredentialName'
references:
$ref: '#/components/schemas/References'
teamsIds:
$ref: '#/components/schemas/TeamsIds'
tsgId:
$ref: '#/components/schemas/TSGId'
required:
- id
- name
- cmsConfigId
- authType
- cmsType
type: object
VSatelliteIds:
description: An array of the VSatellite Ids which are connected to the CMS provider.
items:
$ref: '#/components/schemas/VSatelliteId'
minItems: 1
type: array
uniqueItems: true
TestCMSConfigurationResponse:
description: The result of testing the Credential Manager Service configuration.
properties:
workflowId:
format: uuid
type: string
workflowName:
type: string
required:
- workflowId
- workflowName
type: object
AuthType:
description: "The type of the authentication:\n * `password`\n * `username_password`\n"
enum:
- password
- username_password
type: string
CreateCMSDetails:
oneOf:
- $ref: '#/components/schemas/CreateCyberArkDetails'
- $ref: '#/components/schemas/CreateHashiCorpDetails'
UpdateCredentialDetails:
oneOf:
- $ref: '#/components/schemas/UpdateCyberArkCredDetails'
- $ref: '#/components/schemas/UpdateHashiCorpCredDetails'
TestHashiCorpCredDetails:
allOf:
- $ref: '#/components/schemas/HashiCorpDetails'
ReferenceType:
description: "The type of the reference:\n * `machine`\n"
enum:
- machine
type: string
UpdateCMSDetails:
oneOf:
- $ref: '#/components/schemas/UpdateCyberArkDetails'
- $ref: '#/components/schemas/UpdateHashiCorpDetails'
CreateCMSConfigurationRequest:
description: The information representing a Credential Manager Service configuration for creation purpose.
properties:
cmsDetails:
$ref: '#/components/schemas/CreateCMSDetails'
cmsType:
$ref: '#/components/schemas/CMSType'
consumerTsgIds:
description: List of sub-TSG IDs the configuration is explicitly shared with. Mutually exclusive with shareWithAll=true.
items:
type: string
type: array
name:
$ref: '#/components/schemas/Name'
shareWithAll:
description: When true, the configuration is shared with all sub-TSGs.
type: boolean
vSatelliteIds:
$ref: '#/components/schemas/VSatelliteIds'
required:
- cmsType
- vSatelliteIds
- cmsDetails
type: object
AppId:
description: The application ID from the CyberArk provider.
type: string
TestCredentialResponse:
description: The result of testing access to the credential.
properties:
workflowId:
format: uuid
type: string
workflowName:
type: string
required:
- workflowId
- workflowName
type: object
UpdateHashiCorpCredDetails:
allOf:
- $ref: '#/components/schemas/HashiCorpDetails'
HashiCorpDetailsRequiredProp:
allOf:
- $ref: '#/components/schemas/HashiCorpDetails'
required:
- secretPath
- secretKeyName
TestCyberArkDetails:
allOf:
- $ref: '#/components/schemas/CyberArkConfigurationRequiredProp'
CyberArkConfigurationRequiredProp:
allOf:
- $ref: '#/components/schemas/CyberArkConfiguration'
description: The configuration for the CyberArk app. It's required to set the value for the `cmsType` property to `cyberark`.
required:
- appID
- baseUrl
AddCredentialsResponse:
description: The response for the add credentials action.
properties:
count:
type: integer
credentialsAdded:
items:
$ref: '#/components/schemas/CredentialResponse'
minItems: 1
type: array
required:
- credentialsAdded
- count
type: object
LastModifiedBy:
description: The ID of the user whom modified the credential.
type: string
TestCyberArkCredDetails:
allOf:
- $ref: '#/components/schemas/CyberArkDetails'
CreateCMSConfigurationsResponse:
description: The array of Credential Manager Service configurations created.
properties:
cmsConfigurationsCreated:
items:
$ref: '#/components/schemas/CMSConfigurationResponse'
minItems: 1
type: array
count:
type: integer
required:
- cmsConfigurationsCreated
- count
type: object
CertificateCredentialData:
properties:
certificateBundle:
description: The Base64 encoding certificate bundle encrypted content.
format: byte
type: string
certificateId:
description: The Id of the certificate selected from the Certificate Inventory
format: uuid
type: string
certificatePassword:
description: The password to decrypt the certificate bundle.
format: password
type: string
fingerprint:
description: The fingerprint of the certificate selected from the Certificate Inventory
type: string
type: object
ResponseCyberArkDetails:
allOf:
- $ref: '#/components/schemas/CyberArkConfiguration'
Reference:
description: The machine referenced.
properties:
id:
format: uuid
type: string
type:
$ref: '#/components/schemas/ReferenceType'
required:
- id
- type
type: object
ResponseHashiCorpDetails:
allOf:
- $ref: '#/components/schemas/HashiCorpConfiguration'
CompanyId:
description: The company ID
format: uuid
readOnly: true
type: string
AddCredentialsRequest:
description: Array of credentials to add.
properties:
# --- truncated at 32 KB (41 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/openapi/palo-alto-networks-credential-management-api-openapi.yml