User settings documentation

API and Webhooks
1

The documentation for the Update user settings endpoint shows a sample JSON payload that includes the values that we can update (I didn’t count them, but I estimate there are about 200 of values that can be updated). The following screenshot shows a dozen of the user settings we can update:

image
image508×599 54.6 KB

However, only a very small subset of these values are documented:

- authentication_option
    - action: The authentication action.
    - default_option: The authentication default option.
    - domains: The authentication domains.
    - id: The authentication ID.
    - name: The authentication name.
    - type: The authentication type.

- meeting_authentication: Only authenticated users can join meetings

- recording_authentication: Only authenticated users can view cloud recordings

Similarly, only a very small subset of the settings is documented in the Get user settings endpoint documentation.

I’m pretty sure this information was available at some point in time. Maybe it was lost during the last UI refresh for API references (which occurred about a year ago if I remember correctly)?

2

Hi @desautelsj
Thanks for your patience here.
I have been reviewing our API specs, and it seems like all the values in our spec are included in our Docs. Can you elaborate on what you mean here please?

3

It’s been more than 6 months since I looked at this issue so it‘s not fresh in my memory, but if I remember correctly the issue was that on the right side of the documentation page for this specific endpoint, I can see example of data I can provide for a given user such as pictured in the first screenshot I posted last July (“email_notification” and “feature” are two such examples that are visible in the screenshot) but I couldn’t find any documentation for these settings.

1 Like
4

I see what you mean! Thanks @desautelsj
I escalated this to our Engineering team. Will keep you updated (ZSEE-193789)