Sign in
Integration Instance Auth Credentials

Get Integration Instance Auth Credential

Fetches the auth credential scoped to the given integration instance.

get/v1/integration-instances/{integrationInstanceId}/auth-credential

Response

A response containing an integration instance auth credential.

idstring uuid required
taintedboolean required

Indicates that the credential is no longer valid and must be replaced with a new valid credential.

expires_atstring date-time nullable required

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_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

type'multi_key_auth' required

Example response

{
  "id": "4f535923-ec24-456c-b4e5-e67f65c8c208",
  "integration_instance": {
    "id": "772b9caf-ddbc-4f4f-8aa4-8dfbbe420351",
    "name": "aws-lambda-prod",
    "display_name": "AWS (prod)"
  },
  "missing_permissions": [
    {
      "scopes": [
        "incident:read"
      ]
    }
  ],
  "expires_at": "2025-04-01T07:20:50Z",
  "created_at": "2022-11-04T20:10:06.927Z"
}

Changes

Changed in 2 of the 52 revisions of this API.41

  • 96118a9cd7f44See the full diff
    • ▲

      the response property detail became nullable for the status 401

      response-property-became-nullable

    • ▲

      the response property instance became nullable for the status 401

      response-property-became-nullable

    • ▲

      the response property status became nullable for the status 401

      response-property-became-nullable

    • ▲

      the response property title became nullable for the status 401

      response-property-became-nullable

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9ca62eba4eca1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog