---
title: "Get Integration Instance Auth Credential"
url: "https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8/operations/get-integration-instance-auth-credential"
---

> Full API specification: https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8.md

# Get Integration Instance Auth Credential

`GET` `/integration-instances/{integrationInstanceId}/auth-credential`

Operation ID: `get-integration-instance-auth-credential`

Fetches the auth credential scoped to the given integration instance.

## Path parameters

- `integrationInstanceId` (string, required) - The `id` of the integration instance.

## Responses

- `200` - A response containing an integration instance auth credential.
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Service Catalog
  version: 1.3.0
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
paths:
  /integration-instances/{integrationInstanceId}/auth-credential:
    parameters:
      - schema:
          type: string
          example: 3f51fa25-310a-421d-bd1a-007f859021a3
        name: integrationInstanceId
        in: path
        required: true
        description: The `id` of the integration instance.
    get:
      x-speakeasy-entity-operation:
        terraform-resource: IntegrationInstanceAuthCredential#read
        terraform-datasource: null
      summary: Get Integration Instance Auth Credential
      operationId: get-integration-instance-auth-credential
      description: Fetches the auth credential scoped to the given integration instance.
      responses:
        "200":
          $ref: "#/components/responses/IntegrationInstanceAuthCredentialResponse"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - Integration Instance Auth Credentials
security:
  - konnectAccessToken: []
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  responses:
    IntegrationInstanceAuthCredentialResponse:
      description: A response containing an integration instance auth credential.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/IntegrationInstanceAuthCredential"
          examples:
            SwaggerHub:
              $ref: "#/components/examples/SampleCreateSwaggerHubMultiKeyAuthResponse"
            AwsApiGateway:
              $ref: "#/components/examples/SampleCreateAWSRoleDelegationAuthResponse"
            Dynatrace:
              $ref: "#/components/examples/SampleCreateDynatraceMultiKeyAuthResponse"
            SonarQube:
              $ref: "#/components/examples/SampleCreateSonarQubeMultiKeyAuthResponse"
            azureApiManagement:
              $ref: "#/components/examples/AzureApiManagementAuthConfigResponse"
            azureDevops:
              $ref: "#/components/examples/SampleCreateAzureDevopsMultiKeyAuthResponse"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  schemas:
    IntegrationInstanceAuthCredential:
      title: IntegrationInstanceAuthCredential
      description: Object containing metadata for an integration instance auth credential.
      oneOf:
        - $ref: "#/components/schemas/OAuthCredential"
        - $ref: "#/components/schemas/GitHubAppInstallationCredential"
        - $ref: "#/components/schemas/MultiKeyAuthCredential"
        - $ref: "#/components/schemas/AWSRoleDelegationAuthCredential"
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    OAuthCredential:
      x-speakeasy-param-suppress-computed-diff: true
      type: object
      required:
        - id
        - integration_instance
        - missing_permissions
        - tainted
        - expires_at
        - created_at
        - type
      properties:
        id:
          type: string
          format: uuid
          example: 4f535923-ec24-456c-b4e5-e67f65c8c208
        integration_instance:
          $ref: "#/components/schemas/IntegrationInstanceRef"
        missing_permissions:
          type: array
          description: List of detected missing permissions required to enable the full
            functionality of the given integration instance.
          items:
            $ref: "#/components/schemas/MissingPermission"
        tainted:
          type: boolean
          description: Indicates that the credential is no longer valid and must be
            replaced with a new valid credential.
          example: false
        expires_at:
          type: string
          format: date-time
          nullable: true
          example: 2025-04-01T07:20:50Z
          description: >
            Timestamp denoting when the when the credential will expire in
            RFC-3339 format with a "T" character separating date from time
            within the field value.

            When expired, the credential must be replaced with a new valid
            credential to re-enable full functionality for the given integration
            instance.


            A `null` value indicates no known expiration time.
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        type:
          type: string
          enum:
            - oauth
          x-terraform-transform-const: true
      title: OAuthCredential
      x-speakeasy-name-override: Oauth
      description: Represents a credential scoped to an integration instance that
        supports the `OAuth` authorization strategy.
    GitHubAppInstallationCredential:
      x-speakeasy-param-suppress-computed-diff: true
      type: object
      required:
        - id
        - integration_instance
        - missing_permissions
        - tainted
        - expires_at
        - created_at
        - type
        - config
      properties:
        id:
          type: string
          format: uuid
          example: 4f535923-ec24-456c-b4e5-e67f65c8c208
        integration_instance:
          $ref: "#/components/schemas/IntegrationInstanceRef"
        missing_permissions:
          type: array
          description: List of detected missing permissions required to enable the full
            functionality of the given integration instance.
          items:
            $ref: "#/components/schemas/MissingPermission"
        tainted:
          type: boolean
          description: Indicates that the credential is no longer valid and must be
            replaced with a new valid credential.
          example: false
        expires_at:
          type: string
          format: date-time
          nullable: true
          example: 2025-04-01T07:20:50Z
          description: >
            Timestamp denoting when the when the credential will expire in
            RFC-3339 format with a "T" character separating date from time
            within the field value.

            When expired, the credential must be replaced with a new valid
            credential to re-enable full functionality for the given integration
            instance.


            A `null` value indicates no known expiration time.
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        type:
          type: string
          enum:
            - github_app_installation
          x-terraform-transform-const: true
        config:
          title: GitHubAppInstallationCredentialConfig
          type: object
          required:
            - installation_id
            - app_installed_by
          properties:
            installation_id:
              type: string
              description: The GitHub App installation ID
            app_installed_by:
              type: string
              description: The GitHub user who installed the app.
              nullable: true
      title: GitHubAppInstallationCredential
      x-speakeasy-name-override: GithubAppInstallation
      description: Represents a credential scoped to an integration instance that
        supports the `GitHub App Installation` authorization strategy.
    MultiKeyAuthCredential:
      x-speakeasy-param-suppress-computed-diff: true
      type: object
      required:
        - id
        - integration_instance
        - missing_permissions
        - tainted
        - expires_at
        - created_at
        - type
      properties:
        id:
          type: string
          format: uuid
          example: 4f535923-ec24-456c-b4e5-e67f65c8c208
        integration_instance:
          $ref: "#/components/schemas/IntegrationInstanceRef"
        missing_permissions:
          type: array
          description: List of detected missing permissions required to enable the full
            functionality of the given integration instance.
          items:
            $ref: "#/components/schemas/MissingPermission"
        tainted:
          type: boolean
          description: Indicates that the credential is no longer valid and must be
            replaced with a new valid credential.
          example: false
        expires_at:
          type: string
          format: date-time
          nullable: true
          example: 2025-04-01T07:20:50Z
          description: >
            Timestamp denoting when the when the credential will expire in
            RFC-3339 format with a "T" character separating date from time
            within the field value.

            When expired, the credential must be replaced with a new valid
            credential to re-enable full functionality for the given integration
            instance.


            A `null` value indicates no known expiration time.
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        type:
          type: string
          enum:
            - multi_key_auth
          x-terraform-transform-const: true
      title: MultiKeyAuthCredential
      description: Represents a credential scoped to an integration instance that
        supports the `Multi Key` authorization strategy.
    AWSRoleDelegationAuthCredential:
      x-speakeasy-param-suppress-computed-diff: true
      type: object
      required:
        - id
        - integration_instance
        - missing_permissions
        - tainted
        - expires_at
        - created_at
        - type
        - config
      properties:
        id:
          type: string
          format: uuid
          example: 4f535923-ec24-456c-b4e5-e67f65c8c208
        integration_instance:
          $ref: "#/components/schemas/IntegrationInstanceRef"
        missing_permissions:
          type: array
          description: List of detected missing permissions required to enable the full
            functionality of the given integration instance.
          items:
            $ref: "#/components/schemas/MissingPermission"
        tainted:
          type: boolean
          description: Indicates that the credential is no longer valid and must be
            replaced with a new valid credential.
          example: false
        expires_at:
          type: string
          format: date-time
          nullable: true
          example: 2025-04-01T07:20:50Z
          description: >
            Timestamp denoting when the when the credential will expire in
            RFC-3339 format with a "T" character separating date from time
            within the field value.

            When expired, the credential must be replaced with a new valid
            credential to re-enable full functionality for the given integration
            instance.


            A `null` value indicates no known expiration time.
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        type:
          type: string
          enum:
            - aws_role_delegation
        config:
          title: AWSRoleDelegationAuthCredentialConfig
          type: object
          required:
            - role_arn
          properties:
            role_arn:
              type: string
              description: The Role ARN use for AWS Assume Role.
      title: AWSRoleDelegationAuthCredential
      description: Represents a credential scoped to an integration instance that
        supports the `AWS Role Delegation` authorization strategy.
    BaseError:
      type: object
      title: Error
      description: standard error
      required:
        - status
        - title
        - instance
        - detail
      properties:
        status:
          type: integer
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          readOnly: true
        title:
          type: string
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          readOnly: true
        type:
          type: string
          description: The error type.
          readOnly: true
        instance:
          type: string
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          readOnly: true
        detail:
          type: string
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          readOnly: true
    IntegrationInstanceRef:
      type: object
      description: Short-hand descriptor of an integration instance.
      required:
        - id
        - name
        - display_name
      properties:
        id:
          type: string
          format: uuid
          example: 772b9caf-ddbc-4f4f-8aa4-8dfbbe420351
          description: The integration instance ID.
        name:
          type: string
          description: >
            The machine name of the integration instance that uniquely
            identifies it within the catalog.
          pattern: ^[0-9a-z.-]+$
          example: aws-lambda-prod
        display_name:
          type: string
          description: The display name of the integration instance.
          example: AWS (prod)
    MissingPermission:
      type: object
      required:
        - scopes
        - message
      properties:
        scopes:
          type: array
          items:
            type: string
            nullable: true
          example:
            - incident:read
        message:
          type: string
          description: >
            Describes the degraded experience of the integration instance due to
            the missing permission.

            May also include a message on how to resolve the missing permission.
    CreatedAt:
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      description: An ISO-8601 timestamp representation of entity creation date.
      readOnly: true
      x-speakeasy-param-suppress-computed-diff: true
  examples:
    SampleCreateSwaggerHubMultiKeyAuthResponse:
      value:
        id: 4f535923-ec24-456c-b4e5-e67f65c8c208
        type: multi_key_auth
        missing_permissions: []
        tainted: false
        expires_at: null
        created_at: 2022-11-04T20:10:06.927Z
        integration_instance:
          id: e0f2388b-2efe-42a3-a9e4-86f12d3e8c77
          name: swaggerhub-internal
          display_name: SwaggerHub (Internal)
    SampleCreateAWSRoleDelegationAuthResponse:
      value:
        id: 4f535923-ec24-456c-b4e5-e67f65c8c208
        type: aws_role_delegation
        missing_permissions: []
        tainted: false
        expires_at: null
        created_at: 2022-11-04T20:10:06.927Z
        integration_instance:
          id: e0f2388b-2efe-42a3-a9e4-86f12d3e8c77
          name: swaggerhub-internal
          display_name: SwaggerHub (Internal)
        config:
          role_arn: arn:aws:iam::084735895545:role/KonnectServiceCatalogRole
    SampleCreateDynatraceMultiKeyAuthResponse:
      value:
        id: 88c58c29-ff7d-4913-b3d7-8affc279dd56
        type: multi_key_auth
        missing_permissions: []
        tainted: false
        expires_at: null
        created_at: 2022-11-04T20:10:06.927Z
        integration_instance:
          id: 70ecc595-4280-4872-8b80-87b2e57dba3f
          name: dynatrace
          display_name: Dynatrace
    SampleCreateSonarQubeMultiKeyAuthResponse:
      value:
        id: 1a048e2f-bb24-49b9-bcb3-8a4855cb4d44
        type: multi_key_auth
        missing_permissions: []
        tainted: false
        expires_at: null
        created_at: 2022-11-04T20:10:06.927Z
        integration_instance:
          id: f0f2725e-051d-48fd-a63f-e1e76d5fec34
          name: sonarqube
          display_name: SonarQube
    AzureApiManagementAuthConfigResponse:
      value:
        id: 2b7e1516-28ae-4d6c-8c2f-1e2b3c4d5e6f
        type: oauth
        missing_permissions: []
        tainted: false
        expires_at: null
        created_at: 2022-11-04T20:10:06.927Z
        integration_instance:
          id: 3c9e2f1a-4b5d-6e7f-8a9b-0c1d2e3f4a5b
          name: azure-api-management
          display_name: Azure API Management
    SampleCreateAzureDevopsMultiKeyAuthResponse:
      value:
        id: 7c91b6d3-8e2f-4e2a-9a53-f3b47eac912b
        type: multi_key_auth
        missing_permissions: []
        tainted: false
        expires_at: null
        created_at: 2024-07-18T15:42:29.314Z
        integration_instance:
          id: b4f3d2c9-7a25-43bb-8c47-d7bfa2f91a8e
          name: azure-devops
          display_name: Azure DevOps
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
  securitySchemes:
    konnectAccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        The Konnect access token is meant to be used by the Konnect dashboard
        and the decK CLI authenticate with.
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
```