HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Authentication API v1.1 Manage SAML identity providers API

8 actions 8 updates phrasing extends openapi/here-manage-saml-identity-providers-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for HERE's API. It is a proposal applied on top of the contract, not a document HERE publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/realms/{realm}/samlIdentityProviders'].get
$.paths['/realms/{realm}/samlIdentityProviders'].post
$.paths['/realms/{realm}/samlIdentityProviders/{samlIdentityProvider}/enable'].post
$.paths['/realms/{realm}/samlIdentityProviders/{samlIdentityProvider}/disable'].post
$.paths['/realms/{realm}/samlIdentityProviders/{samlIdentityProvider}'].get
$.paths['/realms/{realm}/samlIdentityProviders/{samlIdentityProvider}'].delete
$.paths['/realms/{realm}/samlIdentityProviders/{samlIdentityProvider}'].patch

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Authentication API v1.1 Manage SAML identity providers API
  version: 1.0.0
extends: openapi/here-manage-saml-identity-providers-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/realms/{realm}/samlIdentityProviders'].get
  update:
    x-apievangelist-phrasing:
      intent: List a realm's SAML identity providers
      effect: read
      questions:
      - Which SAML identity providers are configured for my realm?
      - Can I list only the enabled SAML identity providers?
      instructions:
      - text: List the SAML identity providers in realm {realm}.
        slots:
          realm: path.realm
      - text: Show SAML identity providers in realm {realm} where enabled is {enabled}.
        slots:
          realm: path.realm
          enabled: query.enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/realms/{realm}/samlIdentityProviders'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a SAML identity provider to a realm
      effect: write
      questions:
      - How do I set up single sign-on by adding a SAML identity provider to my realm?
      - Can I validate SAML metadata without actually creating the identity provider?
      - Is a newly added SAML identity provider enabled automatically?
      instructions:
      - text: Create SAML identity provider {name} in realm {realm} from template {identityProviderTemplateId} with metadata {metadataContent}.
        slots:
          name: requestBody.name
          realm: path.realm
          identityProviderTemplateId: requestBody.identityProviderTemplateId
          metadataContent: requestBody.metadataContent
      - text: Dry-run validation {validateOnly} of SAML provider {name} for realm {realm} using template {identityProviderTemplateId} and metadata {metadataContent}.
        slots:
          validateOnly: query.validateOnly
          name: requestBody.name
          realm: path.realm
          identityProviderTemplateId: requestBody.identityProviderTemplateId
          metadataContent: requestBody.metadataContent
      method: generated
      generated: '2026-09-26'
- target: $.paths['/realms/{realm}/samlIdentityProviders/{samlIdentityProvider}/enable'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable a SAML identity provider for login
      effect: write
      questions:
      - How do I switch my realm to log in through a SAML identity provider?
      - Can I keep password login available after enabling SAML sign-on?
      instructions:
      - text: Enable SAML identity provider {samlIdentityProvider} in realm {realm}.
        slots:
          samlIdentityProvider: path.samlIdentityProvider
          realm: path.realm
      - text: Turn on SSO via {samlIdentityProvider} for realm {realm} with password login allowed {allowPasswordLogin}.
        slots:
          samlIdentityProvider: path.samlIdentityProvider
          realm: path.realm
          allowPasswordLogin: query.allowPasswordLogin
      method: generated
      generated: '2026-09-26'
- target: $.paths['/realms/{realm}/samlIdentityProviders/{samlIdentityProvider}/disable'].post
  update:
    x-apievangelist-phrasing:
      intent: Disable a SAML identity provider
      effect: destructive
      questions:
      - How do I turn off SAML sign-on for my realm?
      - Does disabling the only SAML provider revert the realm to password login?
      instructions:
      - text: Disable SAML identity provider {samlIdentityProvider} in realm {realm}.
        slots:
          samlIdentityProvider: path.samlIdentityProvider
          realm: path.realm
      - text: Stop realm {realm} logging in through {samlIdentityProvider} but keep its configuration.
        slots:
          realm: path.realm
          samlIdentityProvider: path.samlIdentityProvider
      method: generated
      generated: '2026-09-26'
- target: $.paths['/realms/{realm}/samlIdentityProviders/{samlIdentityProvider}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a SAML identity provider's configuration
      effect: read
      questions:
      - What entity ID and SSO login URL are set on a SAML identity provider?
      - How do I view the configuration of one SAML provider in my realm?
      instructions:
      - text: Get SAML identity provider {samlIdentityProvider} in realm {realm}.
        slots:
          samlIdentityProvider: path.samlIdentityProvider
          realm: path.realm
      - text: Show the SAML configuration of {samlIdentityProvider} for realm {realm}.
        slots:
          samlIdentityProvider: path.samlIdentityProvider
          realm: path.realm
      method: generated
      generated: '2026-09-26'
- target: $.paths['/realms/{realm}/samlIdentityProviders/{samlIdentityProvider}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a SAML identity provider
      effect: destructive
      questions:
      - How do I permanently remove a SAML identity provider from my realm?
      - Can I delete a SAML provider configuration I no longer use?
      instructions:
      - text: Delete SAML identity provider {samlIdentityProvider} from realm {realm}.
        slots:
          samlIdentityProvider: path.samlIdentityProvider
          realm: path.realm
      - text: Remove the {samlIdentityProvider} SAML configuration from realm {realm} entirely.
        slots:
          samlIdentityProvider: path.samlIdentityProvider
          realm: path.realm
      method: generated
      generated: '2026-09-26'
- target: $.paths['/realms/{realm}/samlIdentityProviders/{samlIdentityProvider}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a SAML identity provider
      effect: write
      questions:
      - How do I update the metadata of an existing SAML identity provider?
      - Can I change the SSO login URL on a SAML provider already configured?
      instructions:
      - text: Update SAML identity provider {samlIdentityProvider} in realm {realm} with new metadata {metadataContent}.
        slots:
          samlIdentityProvider: path.samlIdentityProvider
          realm: path.realm
          metadataContent: requestBody.metadataContent
      - text: Change the SSO login URL of {samlIdentityProvider} in realm {realm} to {ssoLoginUrl}.
        slots:
          samlIdentityProvider: path.samlIdentityProvider
          realm: path.realm
          ssoLoginUrl: requestBody.ssoLoginUrl
      method: generated
      generated: '2026-09-26'