Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal Outbound Provision API

10 actions 10 updates phrasing extends openapi/strivacity-outbound-provision-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Strivacity's API. It is a proposal applied on top of the contract, not a document Strivacity publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 10

$.info
$.paths['/admin/api/v1/identityStores/{identityStoreName}/outboundProvision'].get
$.paths['/admin/api/v1/identityStores/{identityStoreName}/outboundProvision'].post
$.paths['/admin/api/v1/identityStores/{identityStoreName}/outboundProvision/{outboundProvisionId}'].get
$.paths['/admin/api/v1/identityStores/{identityStoreName}/outboundProvision/{outboundProvisionId}'].put
$.paths['/admin/api/v1/identityStores/{identityStoreName}/outboundProvision/{outboundProvisionId}'].delete
$.paths['/admin/api/v1/identityStores/{identityStoreName}/outboundProvision/{outboundProvisionId}/logs'].get
$.paths['/admin/api/v1/identityStores/{identityStoreName}/outboundProvision/{outboundProvisionId}/logs/{id}'].get
$.paths['/admin/api/v1/identityStores/{identityStoreName}/outboundProvision/{outboundProvisionId}/status'].get
$.paths['/admin/api/v1/identityStores/{identityStoreName}/outboundProvision/{outboundProvisionId}/sync'].post

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 Admin Portal Outbound Provision API
  version: 1.0.0
extends: openapi/strivacity-outbound-provision-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: 9
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/outboundProvision'].get
  update:
    x-apievangelist-phrasing:
      intent: List an identity store's outbound provisions
      effect: read
      questions:
      - Which outbound provisioning targets are set up for an identity store?
      - Can I see outbound provisions along with their status?
      instructions:
      - text: List the outbound provisions for identity store {identityStoreName}.
        slots:
          identityStoreName: path.identityStoreName
      - text: Show outbound provisions in {identityStoreName} including their status.
        slots:
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/outboundProvision'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an outbound provision
      effect: write
      questions:
      - How do I push account changes from an identity store to another system?
      - Can I limit how many provisioning jobs run in parallel?
      instructions:
      - text: Create an outbound provision named {name} of type {type} in identity store {identityStoreName}.
        slots:
          name: requestBody.name
          type: requestBody.type
          identityStoreName: path.identityStoreName
      - text: Add outbound provision {name} to {identityStoreName} with at most {maxParallelJobs} parallel jobs.
        slots:
          name: requestBody.name
          identityStoreName: path.identityStoreName
          maxParallelJobs: requestBody.maxParallelJobs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/outboundProvision/{outboundProvisionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an outbound provision
      effect: read
      questions:
      - How can I view the code and filter of one outbound provision?
      - What is configured on a specific provisioning target?
      instructions:
      - text: Show outbound provision {outboundProvisionId} in identity store {identityStoreName}.
        slots:
          outboundProvisionId: path.outboundProvisionId
          identityStoreName: path.identityStoreName
      - text: Fetch the configuration of provision {outboundProvisionId} in {identityStoreName}.
        slots:
          outboundProvisionId: path.outboundProvisionId
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/outboundProvision/{outboundProvisionId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an outbound provision
      effect: write
      questions:
      - How do I change the code or filter of an existing outbound provision?
      - Can I disable an outbound provision without deleting it?
      instructions:
      - text: Update outbound provision {outboundProvisionId} in {identityStoreName} with filter {filter}.
        slots:
          outboundProvisionId: path.outboundProvisionId
          identityStoreName: path.identityStoreName
          filter: requestBody.filter
      - text: Set enabled to {enabled} on provision {outboundProvisionId} in identity store {identityStoreName}.
        slots:
          enabled: requestBody.enabled
          outboundProvisionId: path.outboundProvisionId
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/outboundProvision/{outboundProvisionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an outbound provision
      effect: destructive
      questions:
      - How do I remove a provisioning target from an identity store?
      - Can I stop syncing accounts to a downstream system permanently?
      instructions:
      - text: Delete outbound provision {outboundProvisionId} from identity store {identityStoreName}.
        slots:
          outboundProvisionId: path.outboundProvisionId
          identityStoreName: path.identityStoreName
      - text: Remove provision {outboundProvisionId} in {identityStoreName}.
        slots:
          outboundProvisionId: path.outboundProvisionId
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/outboundProvision/{outboundProvisionId}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: List an outbound provision's function logs
      effect: read
      questions:
      - Why did provisioning fail for a particular account?
      - Can I filter provisioning logs by log level and date range?
      instructions:
      - text: List error logs for provision {outboundProvisionId} in {identityStoreName} at level {logLevels}.
        slots:
          outboundProvisionId: path.outboundProvisionId
          identityStoreName: path.identityStoreName
          logLevels: query.logLevels
      - text: Show provision function logs for account {accountIds} on provision {outboundProvisionId} in {identityStoreName}.
        slots:
          accountIds: query.accountIds
          outboundProvisionId: path.outboundProvisionId
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/outboundProvision/{outboundProvisionId}/logs/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one provision function log entry
      effect: read
      questions:
      - How do I open the full detail of a single provisioning log line?
      - What does one provision function log entry contain?
      instructions:
      - text: Show log entry {id} for provision {outboundProvisionId} in {identityStoreName}.
        slots:
          id: path.id
          outboundProvisionId: path.outboundProvisionId
          identityStoreName: path.identityStoreName
      - text: Open provisioning log {id} of {outboundProvisionId} in identity store {identityStoreName}.
        slots:
          id: path.id
          outboundProvisionId: path.outboundProvisionId
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/outboundProvision/{outboundProvisionId}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an outbound provision's run status
      effect: read
      questions:
      - Is my outbound provisioning function currently running or idle?
      - How can I check whether a full resync has finished?
      instructions:
      - text: Get the status of provision {outboundProvisionId} in {identityStoreName}.
        slots:
          outboundProvisionId: path.outboundProvisionId
          identityStoreName: path.identityStoreName
      - text: Check if provisioning {outboundProvisionId} in identity store {identityStoreName} is still running.
        slots:
          outboundProvisionId: path.outboundProvisionId
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/outboundProvision/{outboundProvisionId}/sync'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a full resync of an outbound provision
      effect: write
      questions:
      - How do I re-push every account in an identity store to a provisioning target?
      - Can I trigger a full resync after fixing my provisioning code?
      instructions:
      - text: Trigger a full resync for provision {outboundProvisionId} in {identityStoreName}.
        slots:
          outboundProvisionId: path.outboundProvisionId
          identityStoreName: path.identityStoreName
      - text: Re-apply provisioning to all accounts in {identityStoreName} via {outboundProvisionId}.
        slots:
          identityStoreName: path.identityStoreName
          outboundProvisionId: path.outboundProvisionId
      method: generated
      generated: '2026-10-01'