Octopus API tokens may be requested using the Authenticate method by passing a user's Maximizer username and password. If you are using Windows authentication, you may omit the user id and password in the request.

When requesting a token you must also specify which Address Book you want to generate the token for by including the Database name for your Address Book in the authentication request.

In general, direct authentication via Octopus API is not recommended for Integrations that act on behalf of an user. Instead, you are encouraged to use OAuth2 to obtain tokens for that user through the Maximizer.Web.Data API.

For more details on how the OAuth2 Authorization Flow works, please refer to Maximizer OAuth.

Authentication on-premise

// POST <BaseURL>/Authenticate
{
    "Database": "{{Database}}",
    "UID": "{{UID}}",
    "Password": "{{Password}}"
}