List security realm configurations

GET /platform/configuration/security/realms

Retrieves a list of security realm configurations.

Responses

  • The security realm configurations were successfully returned

    Hide response attribute Show response attribute object
    • realms array[object] Required

      The list of security realms

      Hide realms attributes Show realms attributes object
      • id string Required

        The identifier for the security realm

      • name string Required

        The friendly name of the security realm

      • type string Required

        The type of the security realm

        Values are native, ldap, saml, or active_directory.

      • enabled boolean

        True if the security realm is enabled

      • order integer(int32)

        The order the security realm should be evaluated

      • urls array[string] Required

        The URLs associated with the security realm

GET /platform/configuration/security/realms
curl \
 -X GET https://{{hostname}}/api/v1/platform/configuration/security/realms
Response examples (200)
{
  "realms": [
    {
      "id": "string",
      "name": "string",
      "type": "native",
      "enabled": true,
      "order": 42,
      "urls": [
        "string"
      ]
    }
  ]
}