HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Authentication API v1.1 Manage Identity Providers for a…

11 actions 11 updates phrasing extends openapi/here-manage-identity-providers-for-a-realm-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 11

$.info

$.paths['/realms/{realm}/identityProviders'].get

$.paths['/realms/{realm}/identityProviders'].post

$.paths['/realms/{realm}/identityProviders/{identityProvider}'].get

$.paths['/realms/{realm}/identityProviders/{identityProvider}'].delete

$.paths['/realms/{realm}/identityProviders/{identityProvider}'].patch

$.paths['/realms/{realm}/identityProviders/{identityProvider}/issuers'].get

$.paths['/realms/{realm}/identityProviders/{identityProvider}/issuers/{issuer}'].get

$.paths['/realms/{realm}/identityProviders/{identityProvider}/issuers/{issuer}'].post

$.paths['/realms/{realm}/identityProviders/{identityProvider}/issuers/{issuer}'].delete

$.paths['/realms/{realm}/identityProviders/{identityProvider}/issuers/{issuer}'].patch

OpenAPI Overlay

# 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 Identity Providers for a…
  version: 1.0.0
extends: openapi/here-manage-identity-providers-for-a-realm-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 10
- target: $.paths['/realms/{realm}/identityProviders'].get
  update:
    x-apievangelist-phrasing:
      intent: List a realm's trusted identity providers
      effect: read
      questions:
      - Which OpenID Connect identity providers does my realm trust?
      - Can I page through the identity providers configured for a realm?
      instructions:
      - text: List the trusted identity providers in realm {realm}.
        slots:
          realm: path.realm
      - text: Show {limit} OpenID Connect providers for realm {realm}.
        slots:
          realm: path.realm
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/realms/{realm}/identityProviders'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a trusted OpenID Connect provider to a realm
      effect: write
      questions:
      - Is there a limit on how many new identity providers I can add to a realm?
      - How do I add my company's OpenID Connect provider to a realm?
      instructions:
      - text: Add identity provider {id} named {name} to realm {realm}.
        slots:
          id: requestBody.id
          name: requestBody.name
          realm: path.realm
      - text: Register OpenID Connect provider {id} in realm {realm} with issuers {issuers}.
        slots:
          id: requestBody.id
          realm: path.realm
          issuers: requestBody.issuers
      method: generated
      generated: '2026-10-02'
- target: $.paths['/realms/{realm}/identityProviders/{identityProvider}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a realm's trusted identity provider
      effect: read
      questions:
      - What is configured for one trusted identity provider in my realm?
      - Can I view the settings of a single OIDC provider?
      instructions:
      - text: Get identity provider {identity_provider} in realm {realm}.
        slots:
          identity_provider: path.identityProvider
          realm: path.realm
      - text: Show the configuration of OIDC provider {identity_provider} for realm {realm}.
        slots:
          identity_provider: path.identityProvider
          realm: path.realm
      method: generated
      generated: '2026-09-26'
- target: $.paths['/realms/{realm}/identityProviders/{identityProvider}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a trusted identity provider from a realm
      effect: destructive
      questions:
      - How do I stop my realm trusting an identity provider?
      - Can I delete an OIDC provider I no longer use?
      instructions:
      - text: Delete identity provider {identity_provider} from realm {realm}.
        slots:
          identity_provider: path.identityProvider
          realm: path.realm
      - text: Remove trust in OIDC provider {identity_provider} for realm {realm}.
        slots:
          identity_provider: path.identityProvider
          realm: path.realm
      method: generated
      generated: '2026-09-26'
- target: $.paths['/realms/{realm}/identityProviders/{identityProvider}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or redescribe a realm identity provider
      effect: write
      questions:
      - Can I change the name or description of an identity provider?
      - Which fields of a trusted identity provider are editable?
      instructions:
      - text: Rename identity provider {identity_provider} in realm {realm} to {name}.
        slots:
          identity_provider: path.identityProvider
          realm: path.realm
          name: requestBody.name
      - text: Update the description of provider {identity_provider} in realm {realm} to {description}.
        slots:
          identity_provider: path.identityProvider
          realm: path.realm
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/realms/{realm}/identityProviders/{identityProvider}/issuers'].get
  update:
    x-apievangelist-phrasing:
      intent: List issuer URLs on an identity provider
      effect: read
      questions:
      - Which issuer URLs are attached to my identity provider?
      - Where can I see all issuers configured for an OIDC provider?
      instructions:
      - text: List the issuers attached to identity provider {identity_provider} in realm {realm}.
        slots:
          identity_provider: path.identityProvider
          realm: path.realm
      - text: Show all issuer URLs for provider {identity_provider} of realm {realm}.
        slots:
          identity_provider: path.identityProvider
          realm: path.realm
      method: generated
      generated: '2026-09-26'
- target: $.paths['/realms/{realm}/identityProviders/{identityProvider}/issuers/{issuer}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one issuer on an identity provider
      effect: read
      questions:
      - Is a particular issuer URL attached to my identity provider?
      - Can I check if a specific issuer is enabled?
      instructions:
      - text: Get issuer {issuer} on identity provider {identity_provider} in realm {realm}.
        slots:
          issuer: path.issuer
          identity_provider: path.identityProvider
          realm: path.realm
      - text: Check whether issuer {issuer} is enabled for provider {identity_provider} in realm {realm}.
        slots:
          issuer: path.issuer
          identity_provider: path.identityProvider
          realm: path.realm
      method: generated
      generated: '2026-09-26'
- target: $.paths['/realms/{realm}/identityProviders/{identityProvider}/issuers/{issuer}'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach an issuer URL to an identity provider
      effect: write
      questions:
      - How many issuer URLs can one identity provider have?
      - How do I attach a new issuer to a trusted provider?
      instructions:
      - text: Attach issuer {issuer} to identity provider {identity_provider} in realm {realm}.
        slots:
          issuer: path.issuer
          identity_provider: path.identityProvider
          realm: path.realm
      - text: Add issuer URL {issuer} to provider {identity_provider} of realm {realm} with enabled {enabled}.
        slots:
          issuer: path.issuer
          identity_provider: path.identityProvider
          realm: path.realm
          enabled: requestBody.enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/realms/{realm}/identityProviders/{identityProvider}/issuers/{issuer}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Detach an issuer from an identity provider
      effect: destructive
      questions:
      - Can I detach an old issuer URL from my identity provider?
      - Can I remove an issuer URL that was attached by mistake?
      instructions:
      - text: Detach issuer {issuer} from identity provider {identity_provider} in realm {realm}.
        slots:
          issuer: path.issuer
          identity_provider: path.identityProvider
          realm: path.realm
      - text: Remove issuer URL {issuer} from provider {identity_provider} of realm {realm}.
        slots:
          issuer: path.issuer
          identity_provider: path.identityProvider
          realm: path.realm
      method: generated
      generated: '2026-09-26'
- target: $.paths['/realms/{realm}/identityProviders/{identityProvider}/issuers/{issuer}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Enable or disable an issuer on an identity provider
      effect: write
      questions:
      - Can I temporarily disable an issuer without detaching it?
      - How do I re-enable an attached issuer URL?
      instructions:
      - text: Set issuer {issuer} on provider {identity_provider} in realm {realm} to enabled {enabled}.
        slots:
          issuer: path.issuer
          identity_provider: path.identityProvider
          realm: path.realm
          enabled: requestBody.enabled
      - text: Disable issuer {issuer} for identity provider {identity_provider} in realm {realm} by setting enabled to {enabled}.
        slots:
          issuer: path.issuer
          identity_provider: path.identityProvider
          realm: path.realm
          enabled: requestBody.enabled
      method: generated
      generated: '2026-09-26'