Forum Discussion

vidhyut_arora's avatar
vidhyut_arora
Advisor
12 years ago

Fetching Community Admin setting via REST API

Hi,

 

I want to retrieve the value of settings I have configured in Community Admin from an external system via REST API. I am aware of how to authenticate, but how can I get the system configuration setting values. 

 

e.g. I want to know what is the URL set in Community Admin --> System --> SSO --> URL to login page

 

 

Can anyone help with the REST API call?

 

 

PS: I know we can get the value using Freemarker, then create an endpoint and use the endpoint to fetch the value. That's the indirect way; I am looking for more of a direct REST API call.

 

 

Thanks,

Vidhyut Arora

  • AdamN's avatar
    AdamN
    12 years ago

    Hi Vidhyut,

     

    You can use this method to get a "Settings" object:

    /restapi/vc/settings

     

    From there, you can use the "name/name" method to get the value of a specific community setting. For example, to get the SSO Login URL:

    /restapi/vc/settings/name/community.signon_url

     

    There are other "settings" methods you can use to get a "Settings" object for nodes (categories, boards, etc) or even a user.

     

    I hope this helps!

     

    -Adam

     

2 Replies

Sort By
  • AdamN's avatar
    AdamN
    Khoros Oracle
    12 years ago

    Hi Vidhyut,

     

    You can use this method to get a "Settings" object:

    /restapi/vc/settings

     

    From there, you can use the "name/name" method to get the value of a specific community setting. For example, to get the SSO Login URL:

    /restapi/vc/settings/name/community.signon_url

     

    There are other "settings" methods you can use to get a "Settings" object for nodes (categories, boards, etc) or even a user.

     

    I hope this helps!

     

    -Adam