Connector Configuration

Global configuration for your connectors. If a component contains either an auth section or authConfig section, values for the specified service will be injected into the `context.config` object.

Only users with admin scope can use these endpoints.

Get Services Configuration

GET https://api.YOUR_TENANT.appmixer.cloud/service-config

Get a list of stored configurations.

Query Parameters

Name	Type	Description
pattern	string	A term to filter configurations containing pattern on their service id
sort	string	Sorting parameter. Service id can be used to sort results alphabetically by their id. Example: serviceId:1
offset	number	Index of the first item returned. Default is 0. Useful for paging.
limit	number	Maximum items returned. Default is 100. Useful for paging.

200

[
	{
		"serviceId": "appmixer:google",
		"clientID": "my-global-client-id",
		"clientSecret": "my-global-client-secret"
	},
	{
		"serviceId": "appmixer:evernote",
		"sandbox": true,
	}
]

Get Service Configuration

GET https://api.YOUR_TENANT.appmixer.cloud/service-config/:serviceId

Get the configuration stored for the given service.

Path Parameters

Name	Type	Description
	string	The service id. Example: appmixer:google

200

{
	"serviceId": "appmixer:google",
	"clientID": "my-global-client-id",
	"clientSecret": "my-global-client-secret"
}

Create Service Configuration

POST https://api.YOUR_TENANT.appmixer.cloud/service-config

Creates a new configuration for a service. The only required parameter on the payload is the serviceId. The rest of the payload can be any key/value pairs that will be the desired configuration for the service. For example: { "serviceId": "appmixer:google", "clientID": "my-global-client-id", "clientSecret": "my-global-client-secret" }

Request Body

Name	Type	Description
whatever	string	Any value for the whatever-key
serviceId	string	The serviceId. It should be in the form vendor:service. Example: appmixer:google

200

{
	"serviceId": "appmixer:google",
	"clientID": "my-global-client-id",
	"clientSecret": "my-global-client-secret"
}

Update Service Configuration

PUT https://api.YOUR_TENANT.appmixer.cloud/service-config/:serviceId

Updates the stored configuration for the given service. The payload should contain the whole configuration, as the payload content will overwrite the configuration stored under the service.

Path Parameters

Name	Type	Description
serviceId	string	The service id. Example

Request Body

Name	Type	Description
whatever-key	string	Any value you need

200

{
	"serviceId": "appmixer:google",
	"clientID": "my-global-client-id",
	"clientSecret": "my-global-client-secret"
}

Delete Service Configuration

DELETE https://api.YOUR_TENANT.appmixer.cloud/service-config/:serviceId

Removes the configuration from the given service.

Path Parameters

Name	Type	Description
serviceId	string	The service id. Example: appmixer:google

200

{}