Service Configuration

Appmixer allows you to save global configuration values for your service. If a component contains either an auth section or authConfig section, values for specified service will be injected.

Only users with admin scope can use these endpoints.

get
Get Services Configuration

/service-config
Get a list of stored configurations.
Request
Response
Request
Query Parameters
pattern
optional
string
A term to filter configurations containing pattern on their service id
sort
optional
string
Sorting parameter. Service id can be used to sort results alphabetically by their id. Example: serviceId:1
offset
optional
number
Index of the first item returned. Default is 0. Useful for paging.
limit
optional
number
Maximum items returned. Default is 100. Useful for paging.
Response
200: OK
[
{
"serviceId": "appmixer:google",
"clientID": "my-global-client-id",
"clientSecret": "my-global-client-secret"
},
{
"serviceId": "appmixer:evernote",
"sandbox": true,
}
]

get
Get Service Configuration

/service-config/:serviceId
Get the configuration stored for the given service.
Request
Response
Request
Path Parameters
required
string
The service id. Example: appmixer:google
Response
200: OK
{
"serviceId": "appmixer:google",
"clientID": "my-global-client-id",
"clientSecret": "my-global-client-secret"
}

post
Create Service Configuration

/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
Response
Request
Body Parameters
whatever
optional
string
Any value for the whatever-key
serviceId
required
string
The serviceId. It should be in the form vendor:service. Example: appmixer:google
Response
200: OK
{
"serviceId": "appmixer:google",
"clientID": "my-global-client-id",
"clientSecret": "my-global-client-secret"
}

put
Update Service Configuration

/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.
Request
Response
Request
Path Parameters
serviceId
required
string
The service id. Example
Body Parameters
whatever-key
optional
string
Any value you need
Response
200: OK
{
"serviceId": "appmixer:google",
"clientID": "my-global-client-id",
"clientSecret": "my-global-client-secret"
}

delete
Delete Service Configuration

/service-config/:serviceId
Removes the configuration from the given service.
Request
Response
Request
Path Parameters
serviceId
required
string
The service id. Example: appmixer:google
Response
200: OK
{}