Improve the documentation on get_idp() function

Open Beginner friendly
#2,453 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
85/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
python
Domain
documentation

Research direction

Open the get_idp() documentation at the linked ArcGIS Python API reference page and review its current description. Remove the “ArcGIS Online Only” wording and clarify that the function supports SAML-based identity federation, not OpenID Connect; confirm the rendered documentation accurately reflects both points.

Written by the indexing model from the issue text.

Description

bug

Describe the bug
On this page the get_idp() function is explained:
https://developers.arcgis.com/python/latest/api-reference/arcgis.gis.admin.html#arcgis.gis.admin.SecuritySettings.get_idp

It it stated that this function works only on AGOL, however with the 2.4.2 release it looks like it also works with Portal. Can you remove the text ArcGIS Online Only.

To me it's unclear that this function only works for SAML and not for OpenID Connect, can you clarify in the documentation that it's only for SAML based identity federation

Thank you

Dominant language
Python
Stars
2.2k
Forks
1.1k
Avg merge
2h 40m
Merged PRs (30d)
2

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Esri/arcgis-python-api

All issues in Esri/arcgis-python-api

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.