Skip to main content

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

OK

Schema
  • meta object
  • pagination object
  • limit integer
  • offset integer
  • total_count int64
  • cursor_pagination object

    Cursors are opaque. Follow the tokens the server returns; never construct, parse or modify one.

  • limit integer
  • next_cursor string

    Opaque token addressing the next page. Absent on the last page.

  • prev_cursor string

    Opaque token addressing the previous page. Absent on the first page.

  • last_cursor string

    Opaque token addressing the final page directly, so a client can jump to the end without a total count.

  • total_count int64

    Total number of matching items. Returned on the FIRST page only; clients cache it for the remainder of the walk.

  • 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.