User

API for users

Sign-in User

POST https://api.YOUR_TENANT.appmixer.cloud/user/auth

Sign-in a user with credentials and get their access token. curl -XPOST "https://api.appmixer.com/user/auth" -H "Content-type: application/json" -d '{ "username": "[e-mail]", "password": "abc321" }'

Request Body

Name	Type	Description
password*	string	Password.
username*	string	Username, has to have an email format.

200

{
    "user": {
        "id": "5c88c7cc04a917256c726c3d",
        "username":"[e-mail]",
        "isActive": false,
        "email": "[e-mail]", 
        "plan":"free"
    },
    "token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVjODhjN2NjMDRhOTE3MjU2YzcyNmMzZCIsInNjb3BlIjpbInVzZXIiXSwiaWF0IjoxNTUyNDkyNjA5LCJleHAiOjE1NTUwODQ2MDl9.9jVcqY0qo9Q_1GeK9Fg14v7OrdpWvzmqnv4jDMZfqnI"
}

Create User

POST https://api.YOUR_TENANT.appmixer.cloud/user

Create user. By default, this endpoint is open (does not require authentication). This can be changed by setting the API_USER_CREATE_SCOPE system configuration. If you set the value of API_USER_CREATE_SCOPE to for example admin, then an admin token will be required to call this API. curl -XPOST "https://api.appmixer.com/user" -H "Content-type: application/json" -d '{ "username": "[e-mail]", "email": "[e-mail]", "password": "abc321" }'

Request Body

Name	Type	Description
password*	string	Password.
email	string	Email address.
username	string	Email address.

201: Created

{
    "token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVjODhjN2NjMDRhOTE3MjU2YzcyNmMzZCIsInNjb3BlIjpbInVzZXIiXSwiaWF0IjoxNTUyNDkyNjA5LCJleHAiOjE1NTUwODQ2MDl9.9jVcqY0qo9Q_1GeK9Fg14v7OrdpWvzmqnv4jDMZfqnI"
}

Get Current User Information

GET https://api.YOUR_TENANT.appmixer.cloud/user

Get current user information. curl "https://api.appmixer.com/user" -H "Authorization: Bearer [ACCESS_TOKEN]"

200

{
  "id": "58593f07c3ee4f239dc69ff7",
  "username": "[e-mail]",
  "isActive": true,
  "email": "[e-mail]",
  "scope": [
    "user"
  ],
  "plan": "beta"
}

Get User Information

GET https://api.YOUR_TENANT.appmixer.cloud/users/:userId

Admin token required.

Get all users

GET https://api.YOUR_TENANT.appmixer.cloud/users

Admin token required.

Examples:

Get the first 30 users with a scope "acme1":

curl -XGET "https://api.appmixer.com/users?filter=scope:acme1&sort=created:-1&limit=30&offset=0" -H 'Authorization: Bearer [ADMIN_TOKEN]'

Get all users who's username includes a pattern:

curl -XGET "https://api.appmixer.com/users?pattern=joe" -H 'Authorization: Beader [ADMIN_TOKEN]'

Get number of users

GET https://api.YOUR_TENANT.appmixer.cloud/users/count

Admin token required

Update user

PUT https://api.YOUR_TENANT.appmixer.cloud/users/:userId

Admin token required.

Request Body

Name	Type	Description
scope	Array	Array of scopes.
vendor	String|Array	One or more vendors.

Delete user

DELETE https://api.YOUR_TENANT.appmixer.cloud/users/:userId

Admin token required. This operation stops all running flows and deletes all the user's data from the system - logs, accounts, tokens ... The response is a ticket, the operation may take a long time. You can use the ticket and poll for the result with the next API method.

200: OK Returns JSON with a ticket. Deleting user may take a long time, you can then use the ticket and poll for the result using the next API method.

{
    "ticket": "830639e3-c53a-42d6-ad43-0276674236b4"
}

GET https://api.YOUR_TENANT.appmixer.cloud/users/:userId/delete-status/:ticket

200: OK

{
    "status": "in-progress | completed | failed | cancelled",
    "stepsDone": 4,       // can be used to display a progress bar
    "stepsTotal": 10      // can be used to display a progress bar
}

Change user password

POST https://api.YOUR_TENANT.appmixer.cloud/user/change-password

User token required.

Request Body

Name	Type	Description
oldPassword*	String	Old password
newPassword*	String	New password

Reset user password

POST https://api.YOUR_TENANT.appmixer.cloud/user/reset-password

Admin token required.

Request Body

Name	Type	Description
email*	String	User email address
password*	String	New password

Forgot Password

POST https://api.YOUR_TENANT.appmixer.cloudforgot-password

See the Forgot Password Service configuration for more details.

Request Body

Name	Type	Description
email*	String	Email address

200

[
    {
        "messageId": "a9b78d3c-ec9a-4c0e-81c2-b1df12bd46d7",
        "flowId": "796d7b5c-bea0-4594-a9df-a8a0e3c4616e",
        "componentId": "fdb29d7b-c6b7-423b-adb2-87b41289e925",
        "messages": {
            "in": [
                {
                    "properties": {
                        "correlationId": "0dcb7b2a-5933-481a-bb9c-c08a865656c0",
                        "gridInstanceId": null,
                        "contentType": "application/json",
                        "contentEncoding": "utf8",
                        "sender": {
                            "componentId": "3961d498-83f8-4714-85ba-0539d3055892",
                            "type": "appmixer.utils.controls.OnStart",
                            "outputPort": "out"
                        },
                        "destination": {
                            "componentId": "fdb29d7b-c6b7-423b-adb2-87b41289e925",
                            "inputPort": "in"
                        },
                        "correlationInPort": null,
                        "componentHeaders": {},
                        "flowId": "796d7b5c-bea0-4594-a9df-a8a0e3c4616e",
                        "messageId": "12374d7e-5c66-40d1-8772-37c424bd4182",
                        "flowRunId": 1603726768950
                    },
                    "content": {
                        "key": "hello"
                    },
                    "scope": {
                        "3961d498-83f8-4714-85ba-0539d3055892": {
                            "out": {
                                "started": "2020-10-26T15:39:29.003Z"
                            }
                        }
                    },
                    "originalContent": {
                        "started": "2020-10-26T15:39:29.003Z"
                    }
                }
            ]
        },
        "created": "2020-10-26T15:39:29.097Z",
        "err": //Stringyfied error object...
    }
]

Reset forgotten password

POST https://api.YOUR_TENANT.appmixer.cloud/forgot-password/reset

Reset user password by providing unique code generated via POST /user/forgot-password API.

Request Body

Name	Type	Description
password*	String	New password. The minimum length of the password is five characters.
code*	String	Code generated via forgot-password.

200

{}