Authenticate a User

Prev Next

This article will show you how to authenticate a user on an API.

Important Note:

You must first create and authenticate the API.

Who can use this feature?

System Administrator

Instructions

  1. Log in to the site with your credentials

  2. After you log in, type in /api after the domain's suffix

    • Example: civicplus.civicplus.com/api

  3. In the site, enter your partition and apiKey fields:The Swagger dashboard with the Partition and API Key fields highlighted.

    Note:

    CivicPlus will provide these values.

  4. For the UserToken, expand the Authentication tab:Swagger dashboard page with the Authentication tab highlighted.

    • Inside of Authentication, there are various API Calls.

  5. Select the API /api/Authentication/v1/Authenticate:Swagger Authentication tab with an API selected.

  6. Click on the Model Schema:Swagger Authentication tab with the Model Schema highlighted.

    • This will automatically populate the userCredentials value:Swagger Authentication Tab with the User Credentials field filled from clicking the Model Schema.

  7. Replace the string value with the proper Username and Password:Swagger Authentication tab with updated user credentials.

  8. Click Do It!:Swagger Authentication tab with the Do it! button highlighted.

    • This should generate an APIKey which will be the UserToken used previously:The Response Body field of the Authentication tab on Swagger is highlighted.

  9. With the UserToken available, you can continue building your API Integration