Register account and get API key

Register account

First of all, you need to register Plumsail Account. This account is used to manage Plumsail Actions and Plumsail Forms products.

It is better to use your active email address. The subscription will be linked to this address.

If you already have an account, just sign in to account.plumsail.com.

Generate API key

You need to navigate to the “API Keys” section and click “Add new”. Then select type of API key according to your needs.

API keys

SharePoint - App auth

This type of key authenticates Actions as an app in your SharePoint tennant. You need to fill domain of your SharePoint Online, click “Submit” and then click “Accept” in the opened window. You may need to allow your browser to open popup windows.

API keys

Note

Though this type of the API key doesn’t depand on users’ permission level and multi-factor authentication enabled for them, it can’t be used with a Create Modern SharePoint Site action.

SharePoint - Custom credentials

This type of key allows SharePoint actions to work under account of specific user. You need to fill account name and password for your user:

API keys

Note

To use this type of the API key, it is necessary to disable multi-factor authentication (MFA) for a user under whose account the key is generated. Actions using the key will have the same level of permissions as the user.

Copy and use API key

Once you created an API key, you can see your key right in the “Secret” column. You can also change a name of a key by clicking on it in the “Name” column:

API keys

Now you can copy and use it in: