HERE · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/here-manage-identity-providers-for-an-app-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 6

$.info

$.paths['/apps/{app}/identityProviders'].get

$.paths['/apps/{app}/identityProviders/{identityProvider}'].get

$.paths['/apps/{app}/identityProviders/{identityProvider}'].post

$.paths['/apps/{app}/identityProviders/{identityProvider}'].delete

$.paths['/apps/{app}/identityProviders/{identityProvider}'].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 an…
  version: 1.0.0
extends: openapi/here-manage-identity-providers-for-an-app-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: 5
- target: $.paths['/apps/{app}/identityProviders'].get
  update:
    x-apievangelist-phrasing:
      intent: List trusted OpenID Connect providers for an app
      effect: read
      questions:
      - Which OpenID Connect identity providers does my app trust?
      - Can I see every OIDC provider attached to one application?
      instructions:
      - text: List trusted OIDC identity providers for app {app}.
        slots:
          app: path.app
      - text: Show all OpenID Connect providers attached to application {app}.
        slots:
          app: path.app
      method: generated
      generated: '2026-09-26'
- target: $.paths['/apps/{app}/identityProviders/{identityProvider}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a trusted OpenID Connect provider for an app
      effect: read
      questions:
      - Is a particular OpenID Connect provider trusted by my app, and is it enabled?
      - Can I view one app's attachment to a specific identity provider?
      instructions:
      - text: Get identity provider {identityProvider} attached to app {app}.
        slots:
          identityProvider: path.identityProvider
          app: path.app
      - text: Check whether app {app} trusts OIDC provider {identityProvider}.
        slots:
          app: path.app
          identityProvider: path.identityProvider
      method: generated
      generated: '2026-09-26'
- target: $.paths['/apps/{app}/identityProviders/{identityProvider}'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a trusted OpenID Connect provider to an app
      effect: write
      questions:
      - How do I let my app accept tokens from an external OpenID Connect provider?
      - Does the app need to be constrained to a project before attaching an identity provider?
      instructions:
      - text: Attach OIDC identity provider {identityProvider} to app {app}.
        slots:
          identityProvider: path.identityProvider
          app: path.app
      - text: Trust identity provider {identityProvider} for app {app} with enabled set to {enabled}.
        slots:
          identityProvider: path.identityProvider
          app: path.app
          enabled: requestBody.enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/apps/{app}/identityProviders/{identityProvider}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Detach an OpenID Connect provider from an app
      effect: destructive
      questions:
      - How do I stop my app from trusting an OpenID Connect provider?
      - Can I remove an identity provider attachment from an application?
      instructions:
      - text: Detach identity provider {identityProvider} from app {app}.
        slots:
          identityProvider: path.identityProvider
          app: path.app
      - text: Remove app {app}'s trust in OIDC provider {identityProvider}.
        slots:
          app: path.app
          identityProvider: path.identityProvider
      method: generated
      generated: '2026-09-26'
- target: $.paths['/apps/{app}/identityProviders/{identityProvider}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Enable or disable an app's OpenID Connect provider
      effect: write
      questions:
      - Can I pause an app's trust in an identity provider without detaching it?
      - How do I re-enable an OIDC provider already attached to my app?
      instructions:
      - text: Set enabled to {enabled} for identity provider {identityProvider} already attached to app {app}.
        slots:
          enabled: requestBody.enabled
          identityProvider: path.identityProvider
          app: path.app
      - text: Disable the existing OIDC attachment {identityProvider} on app {app}.
        slots:
          identityProvider: path.identityProvider
          app: path.app
      method: generated
      generated: '2026-09-26'