Retrieve all credential structures

GET 
/metadata/credentials

This endpoint returns a basic structure of what data must be inputted when adding a credential manually. This should be used when creating a credential using the POST credential endpoint.

This endpoint returns the structure of every supported block on Alloy Embedded. It returns a boolean flag called isOauth which indicates if the credential uses OAuth or an API key.

Request

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

Responses

200

200

application/json

Schema

Schema

data

object[]

Array [

name string

icon string

isOauth boolean

Default value: true

properties

object[]

Array [

name string

displayName string

]

]

Example (from schema)

{
  "data": [
    {
      "name": "acuityScheduling",
      "icon": "acuityScheduling.png",
      "isOauth": false,
      "properties": [
        {
          "name": "apiKey",
          "displayName": "API Key"
        }
      ]
    }
  ]
}

Result

{
	"data": [{
			"name": "acuityScheduling",
			"icon": "acuityScheduling.png",
			"isOauth": false,
			"properties": [{
					"name": "apiKey",
					"displayName": "API Key"
				},
				{
					"name": "userId",
					"displayName": "User Id"
				}
			]
		},
		{
			"name": "netsuite",
			"icon": "netsuite.png",
			"isOauth": false,
			"properties": [{
					"name": "realm",
					"displayName": "Realm",
					"description": "Your NetSuite realm"
				},
				{
					"name": "consumerKey",
					"displayName": "Consumer Key",
					"description": "Your NetSuite consumer key"
				},
				{
					"name": "consumerSecret",
					"displayName": "Consumer Secret",
					"description": "Your NetSuite consumer secret key"
				},
				{
					"name": "tokenId",
					"displayName": "Token Id",
					"description": "Your NetSuite token Id"
				},
				{
					"name": "tokenSecret",
					"displayName": "Token Secret",
					"description": "Your NetSuite token secret"
				}
			]
		},
		{
			"name": "shopify",
			"icon": "shopify.png",
			"isOauth": true,
			"properties": [{
				"name": "shopSubdomain",
				"displayName": "Shop Subdomain",
				"description": "Enter your store subdomain. If your store domain is example.myshopify.com, the subdomain would be example."
			}]
		},
		{
			"name": "snowflake",
			"icon": "snowflake.png",
			"isOauth": false,
			"properties": [{
					"name": "accountName",
					"displayName": "Account Name",
					"description": "The account name for your Snowflake instance"
				},
				{
					"name": "database",
					"displayName": "Database",
					"description": "The database type you want to use"
				},
				{
					"name": "warehouse",
					"displayName": "Data Warehouse",
					"description": "The data warehouse to connect to"
				},
				{
					"name": "username",
					"displayName": "Username",
					"description": "The username to connect to"
				},
				{
					"name": "password",
					"displayName": "Password",
					"description": "The password"
				},
				{
					"name": "schema",
					"displayName": "Schema",
					"description": "The schema"
				},
				{
					"name": "role",
					"displayName": "Role",
					"description": "The role"
				}
			]
		},
		{
			"name": "wooCommerce",
			"icon": "woocommerce.png",
			"isOauth": false,
			"properties": [{
					"name": "consumerKey",
					"displayName": "Consumer Key"
				},
				{
					"name": "consumerSecret",
					"displayName": "Consumer Secret"
				},
				{
					"name": "url",
					"displayName": "WooCommerce URL"
				}
			]
		}
		
	]
}

Loading...