# 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 - Admin Management Admin API Security Policy…
  version: 1.0.0
extends: openapi/strivacity-admin-api-security-policy-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: 5
- target: $.paths['/admin/api/v1/admin/accessPolicy'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the admin API security policy
      effect: read
      questions:
      - What security policy governs access to the admin API?
      - How can I see which clients the admin API policy covers?
      instructions:
      - text: Show the admin API security policy.
      - text: Get the access policy for the admin API.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/accessPolicy/assignments'].post
  update:
    x-apievangelist-phrasing:
      intent: Grant a client access to the admin API
      effect: write
      questions:
      - How do I give a machine client scoped access to the admin API?
      - Can one client have more than one admin API assignment?
      instructions:
      - text: Assign client {client} to admin API policy {apiAccessPolicy} with scopes {scopes}.
        slots:
          client: requestBody.client
          apiAccessPolicy: requestBody.apiAccessPolicy
          scopes: requestBody.scopes
      - text: Grant client {client} the admin API scopes {scopes} under policy {apiAccessPolicy}.
        slots:
          client: requestBody.client
          scopes: requestBody.scopes
          apiAccessPolicy: requestBody.apiAccessPolicy
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/accessPolicy/assignments/{clientId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a client's admin API assignment
      effect: read
      questions:
      - Which admin API scopes does a particular client have?
      - How do I check a client's assignment to the admin API policy?
      instructions:
      - text: Show the admin API assignment for client {clientId}.
        slots:
          clientId: path.clientId
      - text: Get the scopes client {clientId} holds on the admin API.
        slots:
          clientId: path.clientId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/accessPolicy/assignments/{clientId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a client's admin API scopes
      effect: write
      questions:
      - How do I add or remove admin API scopes for an existing client?
      - Can I narrow what a client may do on the admin API?
      instructions:
      - text: Update client {clientId}'s admin API assignment to scopes {scopes}.
        slots:
          clientId: path.clientId
          scopes: requestBody.scopes
      - text: Change the existing assignment of {clientId} to policy {apiAccessPolicy} for client {client} with scopes {scopes}.
        slots:
          clientId: path.clientId
          apiAccessPolicy: requestBody.apiAccessPolicy
          client: requestBody.client
          scopes: requestBody.scopes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/accessPolicy/assignments/{clientId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a client's admin API access
      effect: destructive
      questions:
      - How do I cut off a client's access to the admin API?
      - Can I remove a client assignment from the admin API security policy?
      instructions:
      - text: Delete the admin API assignment for client {clientId}.
        slots:
          clientId: path.clientId
      - text: Revoke admin API access for client {clientId}.
        slots:
          clientId: path.clientId
      method: generated
      generated: '2026-10-01'