# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin Portal Inbound Connection [beta] API
  version: 1.0.0
extends: openapi/strivacity-inbound-connection-beta-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/inboundConnections'].get
  update:
    x-apievangelist-phrasing:
      intent: List an identity store's inbound connections
      effect: read
      questions:
      - What inbound connections feed accounts into an identity store?
      - Can I see all inbound sync connections for one identity store?
      instructions:
      - text: List inbound connections for identity store {identityStoreName}.
        slots:
          identityStoreName: path.identityStoreName
      - text: Show the inbound sync connections of {identityStoreName}.
        slots:
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/inboundConnections'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an inbound connection
      effect: write
      questions:
      - How do I set up an inbound connection to sync users into an identity store?
      - What type and configuration does a new inbound connection need?
      instructions:
      - text: Create inbound connection {name} of type {type} in identity store {identityStoreName}.
        slots:
          name: requestBody.name
          type: requestBody.type
          identityStoreName: path.identityStoreName
      - text: Add inbound connection {name} to {identityStoreName} with configuration {configuration}.
        slots:
          name: requestBody.name
          identityStoreName: path.identityStoreName
          configuration: requestBody.configuration
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/inboundConnections/{inboundConnectionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an inbound connection
      effect: read
      questions:
      - Can I look at the configuration of a single inbound connection?
      - Which attribute mappings does a specific inbound connection use?
      instructions:
      - text: Get inbound connection {inboundConnectionId} in identity store {identityStoreName}.
        slots:
          inboundConnectionId: path.inboundConnectionId
          identityStoreName: path.identityStoreName
      - text: Show details of {identityStoreName} inbound connection {inboundConnectionId}.
        slots:
          inboundConnectionId: path.inboundConnectionId
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/inboundConnections/{inboundConnectionId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an inbound connection
      effect: write
      questions:
      - Can I pause an inbound connection by disabling it?
      - How do I change the attribute mappings on an inbound connection?
      instructions:
      - text: Update mappings of inbound connection {inboundConnectionId} in {identityStoreName} to {mappings}.
        slots:
          inboundConnectionId: path.inboundConnectionId
          identityStoreName: path.identityStoreName
          mappings: requestBody.mappings
      - text: Set enabled to {enabled} on inbound connection {inboundConnectionId} of {identityStoreName}.
        slots:
          enabled: requestBody.enabled
          inboundConnectionId: path.inboundConnectionId
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/inboundConnections/{inboundConnectionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an inbound connection
      effect: destructive
      questions:
      - How do I remove an inbound connection from an identity store?
      - Is deleting an inbound connection reversible?
      instructions:
      - text: Delete inbound connection {inboundConnectionId} from {identityStoreName}.
        slots:
          inboundConnectionId: path.inboundConnectionId
          identityStoreName: path.identityStoreName
      - text: Remove identity store {identityStoreName}'s inbound connection {inboundConnectionId}.
        slots:
          inboundConnectionId: path.inboundConnectionId
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/inboundConnections/{inboundConnectionId}/forceSync'].post
  update:
    x-apievangelist-phrasing:
      intent: Force a sync of an inbound connection
      effect: write
      questions:
      - Can I force a full sync on an inbound connection right now?
      - What do I do when an inbound connection needs to resync immediately?
      instructions:
      - text: Force a sync of inbound connection {inboundConnectionId} in {identityStoreName}.
        slots:
          inboundConnectionId: path.inboundConnectionId
          identityStoreName: path.identityStoreName
      - text: Run a full resync now for {identityStoreName} connection {inboundConnectionId}.
        slots:
          inboundConnectionId: path.inboundConnectionId
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'