Skip to content

Improve the documentation on get_idp() function #2453

Open

Description

@PeaceNlove

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

Activity

  1. nanaeaubry commented on Feb 20, 2026

    @nanaeaubry
    Contributor
  2. mberry-hub commented on May 25, 2026

    @mberry-hub

    Hi, I’d like to work on this documentation update. I confirmed that the current API reference for SecuritySettings.get_idp() still includes “ArcGIS Online Only.” and does not clearly state that the method applies to SAML-based identity federation.

    I searched this public repo for get_idp, SecuritySettings.get_idp, and ArcGIS Online Only, but I could not find the source file that generates that API reference entry. Could someone point me to the correct file or let me know if this API reference content is generated from an internal source?

  3. nanaeaubry commented on Jun 8, 2026

    @nanaeaubry
    Contributor

    @mberry-hub The API references for the Python API is generated from the docstrings of our classes, methods, and properties.

    You do not have access to editing this but we appreciate you wanting to help. We will take a look at updating this for the next release. Thank you :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions