Palo Alto Networks Credentials API

openapi: 3.2.0
info:
  title: Palo Alto Networks Credentials API
  version: '1.0'
  description: 'Operations tagged Credentials across 4 of this provider''s published API definitions: palo-alto-compute-34-03-openapi-34-03-138-sh-openapi.json, palo-alto-compute-openapi-34-04-145-sh-openapi.json, palo-alto-cwpp-34-03-openapi-34-03-138-saas-openapi.json, palo-alto-cwpp-openapi-34-04-145-saas-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: PATH_TO_CONSOLE
tags:
- name: Credentials
  description: Credentials. 4 operations in this definition.
  x-description-source: desc/credentials/credentials.md
paths:
  /api/v34.03/credentials:
    get:
      description: 'Get All Credentials. GET /api/v34.03/credentials on the Credentials API. Takes 8 query parameters. Documented responses: 200.'
      parameters:
      - description: 'Offsets the result to a specific report count. Offset starts from 0.

          '
        in: query
        name: offset
        schema:
          type: integer
      - description: 'Limit is the amount to fix.

          '
        in: query
        name: limit
        schema:
          type: integer
      - description: 'Sorts the result using a key.

          '
        in: query
        name: sort
        schema:
          type: string
      - description: 'Sorts the result in reverse order.

          '
        in: query
        name: reverse
        schema:
          type: boolean
      - description: 'IDs are the credential IDs to filter.

          '
        in: query
        name: ids
        schema:
          description: 'IDs are the credential IDs to filter.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Cloud indicates whether to fetch cloud credentials (AWS/GCP/OCI/Azure) or other types of credentials.

          '
        in: query
        name: cloud
        schema:
          type: boolean
      - description: 'External indicates whether to fetch credentials imported from Prisma.

          '
        in: query
        name: external
        schema:
          type: boolean
      - description: 'AutoImported indicates whether to fetch credentials imported from Prisma automatically.

          '
        in: query
        name: autoImported
        schema:
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/-_cred.Credential'
          description: ''
        default:
          description: ''
      tags:
      - Credentials
      x-prisma-cloud-target-env:
        permission: manageCreds
      operationId: get-credentials
      summary: Get All Credentials
      x-description-source: desc/credentials/get.md
    post:
      description: 'Add Credentials. POST /api/v34.03/credentials on the Credentials API. Takes an optional request body. Documented responses: 200.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cred.Credential'
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Credentials
      x-prisma-cloud-target-env:
        permission: manageCreds
      operationId: post-credentials
      summary: Add Credentials
      x-description-source: desc/credentials/post.md
  /api/v34.03/credentials/{id}:
    delete:
      description: 'Delete a Credential. DELETE /api/v34.03/credentials/{id} on the Credentials API. Takes 1 path parameter. Documented responses: 200.'
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Credentials
      x-prisma-cloud-target-env:
        permission: manageCreds
      operationId: delete-credentials-id
      summary: Delete a Credential
      x-description-source: desc/credentials/id_delete.md
  /api/v34.03/credentials/{id}/usages:
    get:
      description: 'Get Credential Usages. GET /api/v34.03/credentials/{id}/usages on the Credentials API. Takes 1 path parameter. Documented responses: 200.'
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/-_types.CredentialUsage'
          description: ''
        default:
          description: ''
      tags:
      - Credentials
      x-prisma-cloud-target-env:
        permission: manageCreds
      operationId: get-credentials-id-usages
      summary: Get Credential Usages
      x-description-source: desc/credentials/id_usages_get.md
  /api/v34.04/credentials:
    get:
      description: 'Get All Credentials. GET /api/v34.04/credentials on the Credentials API. Takes 8 query parameters. Documented responses: 200.'
      parameters:
      - description: 'Offsets the result to a specific report count. Offset starts from 0.

          '
        in: query
        name: offset
        schema:
          type: integer
      - description: 'Limit is the amount to fix.

          '
        in: query
        name: limit
        schema:
          type: integer
      - description: 'Sorts the result using a key.

          '
        in: query
        name: sort
        schema:
          type: string
      - description: 'Sorts the result in reverse order.

          '
        in: query
        name: reverse
        schema:
          type: boolean
      - description: 'IDs are the credential IDs to filter.

          '
        in: query
        name: ids
        schema:
          description: 'IDs are the credential IDs to filter.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
      - description: 'Cloud indicates whether to fetch cloud credentials (AWS/GCP/OCI/Azure) or other types of credentials.

          '
        in: query
        name: cloud
        schema:
          type: boolean
      - description: 'External indicates whether to fetch credentials imported from Prisma.

          '
        in: query
        name: external
        schema:
          type: boolean
      - description: 'AutoImported indicates whether to fetch credentials imported from Prisma automatically.

          '
        in: query
        name: autoImported
        schema:
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/-_cred.Credential'
          description: ''
        default:
          description: ''
      tags:
      - Credentials
      x-prisma-cloud-target-env:
        permission: manageCreds
      operationId: get-credentials
      summary: Get All Credentials
      x-description-source: desc/credentials/get.md
    post:
      description: 'Add Credentials. POST /api/v34.04/credentials on the Credentials API. Takes an optional request body. Documented responses: 200.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cred.Credential'
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Credentials
      x-prisma-cloud-target-env:
        permission: manageCreds
      operationId: post-credentials
      summary: Add Credentials
      x-description-source: desc/credentials/post.md
  /api/v34.04/credentials/{id}:
    delete:
      description: 'Delete a Credential. DELETE /api/v34.04/credentials/{id} on the Credentials API. Takes 1 path parameter. Documented responses: 200.'
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Credentials
      x-prisma-cloud-target-env:
        permission: manageCreds
      operationId: delete-credentials-id
      summary: Delete a Credential
      x-description-source: desc/credentials/id_delete.md
  /api/v34.04/credentials/{id}/usages:
    get:
      description: 'Get Credential Usages. GET /api/v34.04/credentials/{id}/usages on the Credentials API. Takes 1 path parameter. Documented responses: 200.'
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/-_types.CredentialUsage'
          description: ''
        default:
          description: ''
      tags:
      - Credentials
      x-prisma-cloud-target-env:
        permission: manageCreds
      operationId: get-credentials-id-usages
      summary: Get Credential Usages
      x-description-source: desc/credentials/id_usages_get.md
components:
  schemas:
    cred.Credential:
      description: Credential specifies the authentication data of an external provider
      properties:
        _id:
          description: 'Specifies the unique ID for credential.

            '
          type: string
        accountGUID:
          description: 'Specifies the unique ID for an IBM Cloud account.

            '
          type: string
        accountID:
          description: 'Specifies the account identifier. Example: a username, access key, account GUID, and so on.

            '
          type: string
        accountName:
          description: 'Specifies the name of the cloud account.

            '
          type: string
        apiToken:
          $ref: '#/components/schemas/common.Secret'
        azureSPInfo:
          $ref: '#/components/schemas/cred.AzureSPInfo'
        caCert:
          description: 'Specifies the CA certificate for a certificate-based authentication.

            '
          type: string
        cloudProviderAccountID:
          description: 'Specifies the cloud provider account ID.

            '
          type: string
        created:
          description: 'Specifies the time when the credential was created (or, when the account ID was changed for AWS).

            '
          format: date-time
          type: string
        description:
          description: 'Specifies the description for a credential.

            '
          type: string
        external:
          description: 'Indicates whether the credential was onboarded from the Prisma platform.

            '
          type: boolean
        global:
          description: 'Indicates whether the credential scope is global.

            Available values are:

            true: Global

            false: Not Global

            Note: For GCP, the credential scope is the organization.

            '
          type: boolean
        lastModified:
          description: 'Specifies the time when the credential was last modified.

            '
          format: date-time
          type: string
        ociCred:
          $ref: '#/components/schemas/cred.OCICred'
        owner:
          description: 'Specifies the user who created or modified the credential.

            '
          type: string
        prismaLastModified:
          description: 'Specifies the time when the account was last modified by Prisma Cloud Compute.

            '
          format: int64
          type: integer
        roleArn:
          description: 'Specifies the Amazon Resource Name (ARN) of the role to be assumed.

            '
          type: string
        secret:
          $ref: '#/components/schemas/common.Secret'
        skipVerify:
          description: 'Indicates whether to skip the certificate verification in TLS communication.

            '
          type: boolean
        stsEndpoints:
          description: 'Specifies a list of specific endpoints for use in STS sessions in various regions.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
        tokens:
          $ref: '#/components/schemas/cred.TemporaryToken'
        type:
          $ref: '#/components/schemas/cred.Type'
        url:
          description: 'Specifies the base server URL.

            '
          type: string
        useAWSRole:
          description: 'Indicates whether to authenticate using the IAM Role attached to the instance.

            Available values are:

            true: Authenticate with the attached credentials

            false: Don’t authenticate with the attached credentials.

            '
          type: boolean
        useSTSRegionalEndpoint:
          description: 'Indicates whether to use the regional STS endpoint for an STS session.

            Available values are:

            true: Use the regional STS

            false: Don’t use the regional STS.

            '
          type: boolean
      type: object
    types.CredentialUsage:
      description: CredentialUsage represents a single credential usage
      properties:
        description:
          description: 'Resource description (e.g., repository name for registry scan).

            '
          type: string
        type:
          $ref: '#/components/schemas/cred.UsageType'
      type: object
    cred.Type:
      description: Type specifies the credential type
      enum:
      - - aws
        - azure
        - gcp
        - ibmCloud
        - oci
        - apiToken
        - basic
        - dtr
        - kubeconfig
        - certificate
        - gitlabToken
      type: string
    cred.TemporaryToken:
      description: 'TemporaryToken is a temporary session token for cloud provider APIs

        AWS - https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html

        GCP - https://cloud.google.com/iam/docs/creating-short-lived-service-account-credentials

        Azure - https://docs.microsoft.com/en-us/azure/active-directory/manage-apps/what-is-single-sign-on'
      properties:
        awsAccessKeyId:
          description: 'Specifies a temporary access key.

            '
          type: string
        awsSecretAccessKey:
          $ref: '#/components/schemas/common.Secret'
        duration:
          description: 'Specifies a duration for the token.

            '
          format: int64
          type: integer
        expirationTime:
          description: 'Specifies an expiration time for the token.

            '
          format: date-time
          type: string
        token:
          $ref: '#/components/schemas/common.Secret'
      type: object
    -_types.CredentialUsage:
      items:
        $ref: '#/components/schemas/types.CredentialUsage'
      type: array
    string:
      type: string
    common.Secret:
      description: Secret Stores the plain and encrypted version of a value. The plain version is not stored in a database
      properties:
        encrypted:
          description: 'Specifies an encrypted value of the secret.

            '
          type: string
        plain:
          description: 'Specifies the plain text value of the secret.

            '
          type: string
      type: object
    -_cred.Credential:
      items:
        $ref: '#/components/schemas/cred.Credential'
      type: array
    cred.AzureMIType:
      enum:
      - - user-assigned
        - system-assigned
      type: string
    cred.UsageType:
      description: UsageType represents the credential usage type
      enum:
      - - Alert settings
        - Alert profile
        - Registry Scan
        - Serverless Scan
        - Cloud Scan
        - Secret Store
        - Serverless Auto-Deploy
        - Host Auto-deploy
        - VM Scan
        - Agentless Scan Hub
        - Custom Intelligence Endpoint
        - VMware Tanzu blobstore Scan
        - Kubernetes Audit settings
        - Agentless app firewall
      type: string
    cred.AzureSPInfo:
      description: AzureSPInfo contains the Azure credentials needed for certificate based authentications
      properties:
        clientId:
          description: 'ClientID is the client identifier.

            '
          type: string
        miType:
          $ref: '#/components/schemas/cred.AzureMIType'
        subscriptionId:
          description: 'SubscriptionID is a GUID that uniquely identifies the subscription to use Azure services.

            '
          type: string
        tenantId:
          description: 'TenantID is the ID of the AAD directory in which the application was created.

            '
          type: string
      type: object
    cred.OCICred:
      description: OCICred are additional parameters required for OCI credentials
      properties:
        fingerprint:
          description: 'Fingerprint is the public key signature.

            '
          type: string
        tenancyId:
          description: 'TenancyID is the OCID of the tenancy.

            '
          type: string
      type: object
x-refined-from:
- palo-alto-compute-34-03-openapi-34-03-138-sh-openapi.json
- palo-alto-compute-openapi-34-04-145-sh-openapi.json
- palo-alto-cwpp-34-03-openapi-34-03-138-saas-openapi.json
- palo-alto-cwpp-openapi-34-04-145-saas-openapi.json