What is my API endpoint for authenticating users programmatically with Zendesk | Community
Skip to main content

What is my API endpoint for authenticating users programmatically with Zendesk

  • May 28, 2024
  • 6 replies
  • 0 views
Iva11

Hi there,

 

I am working on implementing SSO in Zendesk. I want to use Auth0 as identity provider. Currently, all user accounts are stored in Zendesk. In order to move to Auth0, I have to first migrate all user accounts into Auth0's database. I want to use Autho's automatic migration feature (see this for details: https://auth0.com/docs/manage-users/user-migration). As part of this, I need to know how to use Zendesk's API for user authentication. I tried to search for docs about this, but I couldn't find anything. My Zendesk URL is this: https://parsebiosciences1710795619.zendesk.com/ Can you point me to what API endpoint I could use to log in against this and also send me docs on how to authenticate the API requests?

 

Many thanks,

Iva

    6 replies

    Integriq
    • Integriq
    • May 29, 2024

    Hi @iva11 

    This API endpoint will give you users (Returns a maximum of 100 records per page. so consider pagination if you have more records )
    https://parsebiosciences1710795619.zendesk.com/api/v2/users.json


    You can read more about authenticating API requests in Zendesk here

    Iva11
    • Iva11
    • Author
    • July 1, 2024

    Hi Sushant,

     

    Thanks for your answer, this makes sense. I am more interested in the API endpoint that I can use to log in an individual user into Zendesk. Basically, I want to call that Zendesk log in endpoint, passing in the username (presumably email address) and a password  of the user, and that endpoint to log the user in to Zendesk successfully.

     

    Do you provide an endpoint for this and what are the specifications? I could not find specifications for a log in endpoint from the link you provided.

     

    Many thanks,

    Iva

    Iva11
    • Iva11
    • Author
    • July 4, 2024

    Hi Sushant,

     

    Could you let me know about what API URL to use or where I can find more information about this? We are currently working on internal user migration script and this information is becoming a blocker for us. Let me know if there is a better place to ask about this!

     

    Thanks,

    Iva

    C
    Hi Iva,
     
    The endpoint for SSO user auth depends on whether you use JWT or SAML.  I recommend following Enabling JWT single sign-on if you're using JWT or Enabling SAML single sign-on if you're using SAML to ensure that your implementation is successful.
    Iva11
    • Iva11
    • Author
    • July 10, 2024

    Hi Christopher,

     

    Thanks for your reply! Let me give you a bit of context about our use case and exactly what we need and why.

     

    We currently don't use SSO for users in Zendesk. Currently users sign into Zendesk directly. We are working on migrating our users to use SSO when signing in. Our SSO provider will be most likely Auth0 and we will be using SAML. Right now, we are working on migrating user data from Zendesk to Auth0 (since Auth0 will be our identity provider and hence the source of truth for user accounts). We are working on setting up automatic user migration, the flow of which is displayed in this diagram: https://auth0.com/docs/manage-users/user-migration#automatic-migrations To implement automatic user migration, as part of the “Are name and password valid in external DB” box displayed in the diagram, we will need to call Zendesk and pass in user information. We need to know what Zendesk endpoint we can use for that and its specifications, so we know what to pass in the automatic user migration scripts in Auth0. As part of that, it would be also super helpful to understand how does Zendesk handle passwords – does it store them as hashes?

     

    Does that make more sense? Let me know if you have any further questions. I am looking forward to your reply!

     

    Thanks,

    Iva

    C
    Hi Iva,
     
    There wouldn't be a way to complete that step because a user's password data cannot be accessed by an external service.  To migrate, you can export users from Zendesk, import to Auth0, and ask the user to set a password in your new Auth0 login flow.
    Terms & ConditionsCookie settingsAccessibility statement