Authentication

API credentials

To access the API, the username and password of a token associated with the account must be used in order to authenticate the API requests.

When an account is created, a user with full permissions is automatically generated. This admin user can then create additional users via the user interface or API.

It is also possible to create a dedicated user specifically for API access. By default, API tokens inherit the same permissions as the primary token (user account) that created them.

For details on how to create an API token:

• Keepit platform: Create an API token 
• PMC: Create an API token in the PMC

The user credentials used must have the necessary permissions to perform the required actions. 

For a list of user roles and permissions:

• Keepit platform: Keepit user roles and permissions
• PMC: User roles and permissions in PMC

Basic authentication

Basic authentication is widely supported by many API tools, including Postman, as well as by various scripting and programming languages, such as PowerShell.

Postman example

PowerShell example

try { 
        $username = '<API Token username>' 
        $password = '<API Token password>' 
        $basicauth = [Convert]::ToBase64String([System.Text.Encoding]::ASCII.GetBytes("${username}:${password}")) 
        $headers = @{ 
            "User-Agent" = "PowerShell-Keepit-API-Agent-1.0" 
            "Authorization" = "Basic $basicauth" 
        }