We have these this line of code in our endpoints for zendesk integration: <#assign username = restadmin("/settings/name/custom_zendesk.username").value /> What is restadmin? What does it contain?

perk it's an object to make a REST call with Administrator permissions on behalf of the user viewing the component. This call essentially bypasses permission checks for the current user. From your code, it looks like you call the 'settings' API method to retrieve the value of the field 'custom_zendesk.username' and assign it to a variable called 'username': <#assign username = restadmin("/settings/name/custom_zendesk.username").value /> More details on the restadmin context object here.

Please keep in mind that the response for the list of settings is paginated, so you'll need to page through it using the "page" parameter. You can also adjust the "page_size" up to 1000 in order to get more results per page. Regarding the custom setting value you mentioned, it will only show up for a user if it was configured as user setting. If instead it's a node (community, category, board, etc) setting, you will need to make the call for the proper node. For example: /restapi/vc/settings?page_size=1000

Thanks! Is there a way to see all the possible values I can retrieve inthis restadmin object?

perk wrote:Thanks! Is there a way to see all the possible values I can retrieve inthis restadmin object? It's just about anything, but a note of caution to be very careful when using restadmin. It's basically making calls as an administrator, so you can easily expose unwanted information to users if not careful. Wjhen you want to make the cal as a normal use, use "rest".

Thanks! How may I know what other variables exist in /settings/name/ ? Is there a list I can access somewhere?

Forum Discussion

perk

Adept

10 years ago

What is restadmin?

We have these this line of code in our endpoints for zendesk integration:

<#assign username = restadmin("/settings/name/custom_zendesk.username").value />

What is restadmin? What does it contain?

11 Replies

AdamN
Khoros Oracle
10 years ago
Please keep in mind that the response for the list of settings is paginated, so you'll need to page through it using the "page" parameter. You can also adjust the "page_size" up to 1000 in order to get more results per page.

Regarding the custom setting value you mentioned, it will only show up for a user if it was configured as user setting. If instead it's a node (community, category, board, etc) setting, you will need to make the call for the proper node. For example:

/restapi/vc/settings?page_size=1000

Forum Discussion

What is restadmin?

11 Replies

Related Content

rest vs restadmin API Call

restadmin threads potential bug

How to list API V1 results? No LIST as in V2?

Re: only show component if tkb article has a specific label

Is it possible to clear user cache for another user via FreeMarker?

Recent Discussions

Join node/group 301 API error

liqlAdmin in khoros aurora graphql API

How do I get the article ID in Freemarker in a TkbArticle?

How to retrieve "Internal reason for ban" field

Tips on keeping stage and prod in alignment?