Skip to main content
Yair Acosta
New Participant
Oct 2, 2025 2:05 PM UTC

Can you use CityWorks Server 15.8 API with Active Directory? If so, can you provide an example. Thanks.

We are in the process of creating an AD site for CityWorks and are wondering about how to use the APIs. We have tried using them but it returns Invalid Credentials. We are wondering if we are missing something on the setup or do we need to have a second non AD site for this purpose.

    3 replies

    Yair AcostaAuthor
    New Participant
    Oct 2, 2025 4:08 PM UTC

    Thank you very much. This helps a lot.

    Translate
    Max Reeves
    New Participant
    Oct 2, 2025 4:09 PM UTC

    Hi @yair acosta? 

    You can leverage the API against a Windows Authenticated Cityworks site. Here is an example authentication call that works in my environment:

     

    https://<your host>/<your site>/Services/General/Authentication/Authenticate?data={"LoginName":"domainjdoe","Password":"jdoe"}

     

    Where the domain is accounted for with the username, and the additional backslash is needed as well. The password should be the Cityworks application password (not the true Windows AD pw). If you're unsure the password, you can reset it in Admin/Designer.

     

    Some clients do have a separate site specifically for API usage when heavy usage is anticipated simply to help reduce the load on the live site being used by end users, but it is not required and completely up to your org.

     

    We do also recommend creating a dedicated API user that is not tied to a live end user to minimize issues like unintentionally revoking tokens, changes in passwords or user configuration, etc.

     

    Hope this helps.

    Thanks,

    Max

    Translate
    Max Reeves
    New Participant
    Oct 2, 2025 4:09 PM UTC

    Happy to help, best of luck with your API endeavors!

    Translate
    Terms & ConditionsAccessibility statement