Accounts
Authentication to apps.
Get Accounts
GET
https://api.appmixer.com/auth/:componentType
Get list of accounts the user has previously authenticated with for this component type.
curl "https://api.appmixer.com/auth/appmixer.slack.list.SendChannelMessage?componentId=e15ef119-8fcb-459b-aaae-2a3f9ee41f15" -H "Authorization: Bearer [ACCESS_TOKEN]"
Path Parameters
Query Parameters
Get All Accounts
GET
https://api.appmixer.com/accounts
Get list of all accounts the user has authenticated with to any component.
curl "https://api.appmixer.com/accounts" -H "Authorization: Bearer [ACCESS_TOKEN]"
Update Account Info
PUT
https://api.appmixer.com/accounts/:accountId
Update account information. Currently, only the display name can be updated. The display name is visible in the Designer inspector when selecting available accounts for a component type and also on the Accounts page.
curl -XPUT "https://api.appmixer.com/accounts/5a6e21f3b266224186ac7d03" -H "Authorization: Bearer [ACCESS_TOKEN]" -H "Content-Type: application/json" -d '{ "displayName": "My Account Name" }'
Path Parameters
Request Body
Test Account
POST
https://api.appmixer.com/accounts/:accountId/test
Test account. Check if all the credentials (tokens) are still valid for the account.
curl -XPOST "https://api.appmixer.com/accounts/5a6e21f3b266224186ac7d03/test" -H "Authorization: Bearer [ACCESS_TOKEN]"
Path Parameters
Remove Account
DELETE
https://api.appmixer.com/accounts/:accountId
Remove account and stop all the flows that this account is used in.
curl -XDELETE "https://api.appmixer.com/accounts/5a6e21f3b266224186ac7d03" -H "Authorization: Bearer [ACCESS_TOKEN]"
Path Parameters
List All Flows Using Account
GET
https://api.appmixer.com/accounts/:accountId/flows
List all the flows where the account is used.
curl "https://api.appmixer.com/accounts/5a6e21f3b266224186ac7d03/flows" -H "Authorization: Bearer [ACCESS_TOKEN]"
Path Parameters
Generate Authentication Session Ticket
POST
https://api.appmixer.com/auth/ticket
Generate an authentication session ticket. This is the first call to be made before the user can authentication to a service. The flow is as follows:
1. Generate an authentication session ticket.
2. Get an authentication URL.
3. Start an authentication session.
4. Open the authentication URL in a browser to start the authentication flow.
5. Once the user completes the authentication flow, the browser redirects the user to a special Appmixer page which posts a message of the form "appmixer.auth.[success/failure].[ticket]" via the window.postMessage() call: https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage.
Note that this is a low-level mechanism that you don't have to normally deal with. The Appmixer JS SDK handles all this for you.
curl "https://api.appmixer.com/auth/ticket" -H "Authorization: Bearer [ACCESS_TOKEN]"
Get Authentication URL
GET
https://api.appmixer.com/auth/:componentType/auth-url/:ticket
Get an authentication URL.
curl "https://api.appmixer.com/auth/appmixer.slack.list.SendChannelMessage/auth-url/58593f07c3ee4f239dc69ff7:1d2a90df-b192-4a47-aaff-5a80bab66de5" -H "Authorization: Bearer [ACCESS_TOKEN]"
Path Parameters
Query Parameters
Start Authentication Session
PUT
https://api.appmixer.com/auth/:componentType/ticket/:ticket
Start authentication session.
curl -XPUT "https://api.appmixer.com/auth/appmixer.slack.list.SendChannelMessage/ticket/58593f07c3ee4f239dc69ff7:68982d38-d00c-4345-9a4a-82360d7e1649" -H "Authorization: Bearer [ACCESS_TOKEN]"
Path Parameters
Clear Authentication From Component
DELETE
https://api.appmixer.com/auth/component/:componentId
Clear authentication associated with the component. Note that this call does not remove the account, it only removes the association of an account with a component.
curl -XDELETE "https://api.appmixer.com/auth/component/e25dc901-f92a-46a2-8d29-2573d4ad65e5" -H "Authorization: Bearer [ACCESS_TOKEN]"
Path Parameters
Assign Account To Component
PUT
https://api.appmixer.com/auth/component/:componentId/:accountId
Assign an account to a component.
curl -XPUT "https://api.appmixer.com/auth/component/e25dc901-f92a-46a2-8d29-2573d4ad65e5/5a6e21f3b266224186ac7d03" -H "Authorization: Bearer [ACCESS_TOKEN]"
Path Parameters
Last updated