Recent searches


No recent searches

Zendesk API to get User Roles and Access



Posted Mar 15, 2021

Is there any API available to see the list of an agent's product access/roles and also add / remove product from this list?


2

6

6 comments

image avatar

Greg Katechis

Zendesk Developer Advocacy

Hi Rikita! Depending on what you're looking for, you may find it in the Users API or if you're on an Enterprise plan and have custom roles, the Custom Agent Roles API.

0


Hi,

I think the question is not around setting a Support role, but adjusting Access to to the various products. Changing access in the UI has the browser hitting this endpoint:

https://{subdomain}/api/admin/private/staff/{userID}/entitlements

This API isn't published in the API docs. Is there any roadmap for supporting this?

1


image avatar

Romona

Zendesk Customer Care

Hi Ryon, 
 
Unfortunately entitlements are not publicly accessible via the API at this time. However, it is on our product road map in the future but we do not have eta for when this feature will be released. 

0


It would be nice if this API endpoint https://{subdomain}/api/admin/private/staff/{userID}/entitlements could be officially supported by Zendesk and a published API Doc.

As of now, I am able to activate only TALK via API via PUT Method. For chat, we need POST method but it says "You may have mistyped the address or the page may have moved." for the same endpoint which works fine for PUT methods. 

If Zendesk could add these lines below as default to a user's entitlement here https://{subdomain}/api/admin/private/staff/{userID}/entitlements it would fix it and we could use the PUT methods.

 "entitlements": {
    "chat": {
      "user_id": {userID},
      "name": "agent",
      "is_active": false
    }

1


FWIW I was able to activate Chat via PUT with the following JSON (we're using a custom role for Support). It works even if the Chat object does not exist on the user and you don't need to supply the user_id parameter since it's in the URL.

{
  "entitlements": {
    "chat": {
      "name": "agent",
      "is_active": true
    },
    "explore": {
      "name": "admin",
      "is_active": true
    },
    "guide": {
      "name": "admin",
      "is_active": true
    },
    "support": {
      "name": "custom_16653721760667",
      "is_active": true
    },
    "talk": {
      "name": "agent",
      "is_active": false
    }
  }
}

1


Greg Katechis

Is there an update to this? Being able to update many users roles and access in one go via the API will be a really good addition.

0


Please sign in to leave a comment.

Didn't find what you're looking for?

New post