Skip to main content

Search

We are excited to announce the launch of updated product names, logos, and headers within our user interfaces as part of the CivicPlus® Solution Rebranding initiative. These changes mark the first step toward creating a cohesive and seamless user experience across all solutions in our portfolio. As part of this transition, users may notice minor design updates. While the functionality you rely on remains unchanged, we are in the process of updating screenshots and other resources on our Help Centers to reflect the new branding. We appreciate your patience and understanding as we work to complete these updates.

Authenticate a User

  • Updated:

This article will show you how to authenticate a user on an Application Programming Interface (API).

 

Important Note

You must first create and authenticate the API.

 

Who can use this feature?
System Administrator

 

 

Instructions

  1. Log into 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
    Partition and API Key boxes.
    Note: CivicPlus will provide these values.
  4. For the UserToken, expand the Authentication tab
    Authentication selection.
    • Inside of Authentication, there are various API Calls.
  5. Select the API /api/Authentication/v1/Authenticate
    Select the correct API.
  6. Click on the Model Schema
    Model schema box.
    • This will automatically populate the userCredentials value. 
      User Credentials box.
  7. Replace the string value with the proper Username and Password
    Insert a new username and password.
  8. Click Do It!
    The Do it! button.
    • This should generate an APIKey which will be the UserToken used above.
      Response body box.
  9. With the UserToken available, you can continue building your API Integration
Was this article helpful?
0 out of 1 found this helpful
Return to top

Feedback About the Article

Let us know what was helpful or not helpful about the article below.

0 comments

Please sign in to leave a comment.