Get organization IdP

GET /organizations/{organization_id}/idp

Gets the oranization's IdP. Currently unavailable in self-hosted ECE.

Path parameters

Responses

  • 200 application/json

    The IdP info

    Hide response attributes Show response attributes object
    • login_identifier string Required

      The login identifier that is unique to this organization

    • sso_login_url string Required

      The Elastic Cloud login URL for this IdP

    • metadata_url string Required

      The SAML2 metadata url for downloading the SAML2 SP metadata XML

    • acs string Required

      The SAML2 assertion consumer service of the SP

    • sp_entity_id string Required

      The SP entity ID and the audience for SAML2 response assertions

    • signing_certificate array[string] Required

      The certificate that will sign SAML2 requests to the IdP

    • configuration object Required

      The organization's IdP configuration

      Hide configuration attributes Show configuration attributes object
      • enabled boolean Required

        Whether or not the IdP is enabled

      • The prefix of the login identifier that will be generated

      • saml_idp object Required

        The SAML2 IdP configuration

        Hide saml_idp attributes Show saml_idp attributes object
        • public_certificate array[string] Required

          Base64-encoded PEM-format X.509 certificate

        • issuer string Required

          The IdP URI that identifies the issuer of a SAML2 response message assertion

        • sso_url string Required

          The IdP SAML HTTP-POST endpoint URL that will receive SAML requests during SP-initiated login

  • 404 application/json

    IdP was not configured yet. (code: org.idp.idp_not_configured)

    Hide headers attribute Show headers attribute
    • The error codes associated with the response

      Value is org.idp.idp_not_configured.

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

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields

GET /organizations/{organization_id}/idp
curl \
 --request GET https://api.elastic-cloud.com/api/v1/organizations/{organization_id}/idp
Response examples (200)
{
  "login_identifier": "string",
  "sso_login_url": "string",
  "metadata_url": "string",
  "acs": "string",
  "sp_entity_id": "string",
  "signing_certificate": [
    "string"
  ],
  "configuration": {
    "enabled": true,
    "login_identifier_prefix": "string",
    "saml_idp": {
      "public_certificate": [
        "string"
      ],
      "issuer": "string",
      "sso_url": "string"
    }
  }
}
Response examples (404)
# Headers
x-cloud-error-codes: org.idp.idp_not_configured

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}