Get the specified credential

Returns the credential specified by the ID. The returned object contains the name of the provider, the credential type and an object which contains the credential material necessary to access a third-party provider (API Key, API ID/API Key, Client Credentials, Access Token and username/password)

Path Parameters

• cred_id string required

  ID of the credential to retrieve, modify or delete

Header Parameters

• SlashID-OrgID string required

  The organization ID

  Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1

Responses

• 200
• 400
• 404

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• meta object

  pagination object

  limit integer

  offset integer

  total_count int64

  cursor_pagination object

  limit integer

  cursor string

  total_count int64
• errors object[]

  httpcode integer

  message string
• result object

  external_cred_id string

  External credential ID

  organization_id string

  extcred_provider string

  Possible values: [google, onfido, shopify, generic]

  extcred_label string

  extcred_type string

  Possible values: [api_key, client_credentials, user_pass, api_id_access, access_token, json_credentials]

  json_blob object

  Free form object for implicit server to server authentication credentials, different schema for provider.

{
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total_count": 0
    },
    "cursor_pagination": {
      "limit": 0,
      "cursor": "string",
      "total_count": 0
    }
  },
  "errors": [
    {
      "httpcode": 0,
      "message": "string"
    }
  ],
  "result": {
    "external_cred_id": "string",
    "organization_id": "string",
    "extcred_provider": "google",
    "extcred_label": "string",
    "extcred_type": "api_key",
    "json_blob": {}
  }
}

Bad Request

application/json

• Schema
• Example (from schema)

---

Schema

• meta object

  pagination object

  limit integer

  offset integer

  total_count int64

  cursor_pagination object

  limit integer

  cursor string

  total_count int64
• errors object[]

  httpcode integer

  message string

{
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total_count": 0
    },
    "cursor_pagination": {
      "limit": 0,
      "cursor": "string",
      "total_count": 0
    }
  },
  "errors": [
    {
      "httpcode": 0,
      "message": "string"
    }
  ]
}

Not Found

application/json

• Schema
• Example (from schema)

---

Schema

• meta object

  pagination object

  limit integer

  offset integer

  total_count int64

  cursor_pagination object

  limit integer

  cursor string

  total_count int64
• errors object[]

  httpcode integer

  message string

{
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total_count": 0
    },
    "cursor_pagination": {
      "limit": 0,
      "cursor": "string",
      "total_count": 0
    }
  },
  "errors": [
    {
      "httpcode": 0,
      "message": "string"
    }
  ]
}