When I log into Genesys Cloud as an admin, I can navigate to:
Admin -> Organization Settings
Where tabs such as Organization Details, Settings, Authentication, Status Management appear. I have been examining what API calls my browser makes when this occurs. The following settings are within the Settings tab under the Onboarding People heading:
Auto Invite
Open Admission
Allowed Email Domain(s)
I have observed the browser performing HTTP GET /directory/api/v1/org to obtain these settings. I am unable to find any reference to this URI or those settings within the Platform API via API Explorer.
My questions are:
If this information is obtainable via Platform API (maybe I am not looking in the right place)
It feels sketchy to perform a REST call via implicit grant to /directory/api/v1/org when I can't find it documented for consumption - any opinion on general best practice in this case? For example: A-Don't do it B-Do it at your own risk knowing it may change / fail without notice
You are correct, that is a sketchy thing to do. Using those endpoints will risk a production outage for your integration. That directory path is not part of the Genesys Cloud Platform API, is not documented, is not supported, and is therefore not acceptable for customers to use. The endpoints in that path can, and definitely will, have breaking changes at some point in the future that will not be announced in any way because they're not for public consumption.
You can request new features, like exposing these settings via the Platform API, and share your use case at https://genesyscloud.ideas.aha.io/.
Thanks Tim, I will proceed with option A, "Don't do it". You confirmed my suspicion - I'm trying to be a good citizen and not go rogue - thanks for not blowing me up.
My goal is to automate pulling settings out for documentation purposes. Are you aware of any other methodology to get at the settings I mentioned? If not, I will wrap up what I am doing, will document the items not available via Platform API and submit an enhancement request as suggested. If I were a PM I would shoot down my request - but you never know unless you ask!
There's an ongoing effort to get those private APIs migrated to the public-facing Platform API, but it's not a quick process to rebuild/migrate core parts of the backend platform like that. There's no workaround other than to use the UI for the time being. Posting on the ideas site does help with prioritization though. The Product Management team uses the metrics from that site as a key component when justifying adding new features. Votes help to increase visibility and explaining your use case provides concrete business cases to justify the priority.
Not that this will help you with your specific queistion, but just wanted to make sure you're aware of CX as Code for your general purpose. It wraps the Platform API (i.e. not the endpoint you're asking about) for bi-directional configuration processing using Terraform. This could be an easy tool to help you make backups of configurations like queues, divisions, etc. If you have any questions about it, please create a new topic in the CX as Code category; I don't personally work with it and won't be of much help answering questions about it.
Using those endpoints will risk a production outage for your integration. That directory path is not part of the Genesys Cloud Platform API, is not documented, is not supported, and is therefore not acceptable for customers to use. The endpoints in that path can, and definitely will, have breaking changes at some point in the future that will not be announced in any way because they're not for public consumption.