Akuity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Akuity Platform API — Organization Organization Service API

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

What the actions change

x-apievangelist-phrasing

Targets 193 · first 16 shown; the file carries all of them

$.info
$.paths['/api/v1/billing/plans'].get
$.paths['/api/v1/organizations'].get
$.paths['/api/v1/organizations'].post
$.paths['/api/v1/organizations/{id}'].get
$.paths['/api/v1/organizations/{id}'].put
$.paths['/api/v1/organizations/{id}'].delete
$.paths['/api/v1/organizations/{id}/apikeys'].get
$.paths['/api/v1/organizations/{id}/apikeys'].post
$.paths['/api/v1/organizations/{id}/audit-logs'].get
$.paths['/api/v1/organizations/{id}/audit-logs-archives'].get
$.paths['/api/v1/organizations/{id}/billing'].patch
$.paths['/api/v1/organizations/{id}/billing/customer'].get
$.paths['/api/v1/organizations/{id}/billing/subscription'].patch
$.paths['/api/v1/organizations/{id}/billing/{plan}/addons'].get
$.paths['/api/v1/organizations/{id}/checkout'].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 Akuity Platform API — Organization Organization Service API
  version: 1.0.0
extends: openapi/akuity-organizationservice-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: 192
- target: $.paths['/api/v1/billing/plans'].get
  update:
    x-apievangelist-phrasing:
      intent: List available billing plans
      effect: read
      questions:
      - What subscription plans can I choose from on Akuity?
      - Which billing tiers are offered for an Akuity organization?
      instructions:
      - text: Show me all the billing plans I can subscribe to.
      - text: Look up billing plan {plan_id} in the plans catalog.
        slots:
          plan_id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations'].get
  update:
    x-apievangelist-phrasing:
      intent: List the organizations I belong to
      effect: read
      questions:
      - Which organizations is my user account a member of?
      - Can I see every org I have access to with my login?
      instructions:
      - text: List all organizations my account belongs to.
      - text: Show the orgs I'm signed into so I can pick one.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new organization
      effect: write
      questions:
      - How do I set up a brand-new organization?
      - Can I create another org under my account with its own name?
      instructions:
      - text: Create a new organization named {name}.
        slots:
          name: requestBody.name
      - text: Set up an org called {name} for our platform team.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization's details
      effect: read
      questions:
      - What details are stored for a specific organization?
      - Can I look up an org by its name instead of its ID?
      instructions:
      - text: Show the details of organization {id}.
        slots:
          id: path.id
      - text: Fetch organization {id} using id type {idType}.
        slots:
          id: path.id
          idType: query.idType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update organization settings
      effect: write
      questions:
      - Can I rename my organization or change its MFA and AI settings?
      - Where do I turn on required MFA for everyone in the org?
      instructions:
      - text: Rename organization {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Update the MFA settings on organization {id} to {mfa}.
        slots:
          id: path.id
          mfa: requestBody.mfa
      - text: Change the AI settings for organization {id} to {ai}.
        slots:
          id: path.id
          ai: requestBody.ai
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an organization
      effect: destructive
      questions:
      - How do I permanently delete an organization I no longer need?
      - Is it possible to remove a whole org and everything under it?
      instructions:
      - text: Delete organization {id}.
        slots:
          id: path.id
      - text: Permanently remove org {id} from Akuity.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{id}/apikeys'].get
  update:
    x-apievangelist-phrasing:
      intent: List organization-level API keys
      effect: read
      questions:
      - Which API keys have been issued at the organization level?
      - Can I audit the org-wide API keys that exist today?
      instructions:
      - text: List the organization API keys for org {id}.
        slots:
          id: path.id
      - text: Show every org-scoped API key in organization {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{id}/apikeys'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an organization-level API key
      effect: write
      questions:
      - How do I generate an API key that works across the whole organization?
      - Can I set an expiry and specific permissions on a new org API key?
      instructions:
      - text: Create an org API key in organization {id} described as {description}.
        slots:
          id: path.id
          description: requestBody.description
      - text: Issue an organization API key for org {id} that expires in {expireInDuration} with permissions {permissions}.
        slots:
          id: path.id
          expireInDuration: requestBody.expireInDuration
          permissions: requestBody.permissions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{id}/audit-logs'].get
  update:
    x-apievangelist-phrasing:
      intent: View the organization's audit log
      effect: read
      questions:
      - Who changed what in my organization recently?
      - Where can I read the audit trail of actions taken in our org?
      instructions:
      - text: Show the audit log for organization {id}.
        slots:
          id: path.id
      - text: Pull recent audit log entries for org {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{id}/audit-logs-archives'].get
  update:
    x-apievangelist-phrasing:
      intent: List archived audit log bundles
      effect: read
      questions:
      - Are older audit logs archived somewhere I can list?
      - Which audit log archives are available for my organization?
      instructions:
      - text: List the audit log archives for organization {id}.
        slots:
          id: path.id
      - text: Show which archived audit log files exist for org {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{id}/billing'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update billing details
      effect: write
      questions:
      - How do I change the billing address or contact on my org?
      - Can I edit the invoice details Akuity bills us with?
      instructions:
      - text: Update the billing details for organization {id} to {billingDetails}.
        slots:
          id: path.id
          billingDetails: requestBody.billingDetails
      - text: Change the billing information on org {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{id}/billing/customer'].get
  update:
    x-apievangelist-phrasing:
      intent: Get billing customer details
      effect: read
      questions:
      - What billing customer record is on file for my organization?
      - Can I see the customer account used for our invoices?
      instructions:
      - text: Show the billing customer details for organization {id}.
        slots:
          id: path.id
      - text: Fetch the customer record behind org {id}'s billing.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{id}/billing/subscription'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change the subscription plan or add-ons
      effect: write
      questions:
      - Can I upgrade my organization to a different plan?
      - How do I add or drop add-ons on an existing subscription?
      instructions:
      - text: Switch organization {id}'s subscription to plan {plan}.
        slots:
          id: path.id
          plan: requestBody.plan
      - text: Update the add-ons on org {id}'s subscription to {addons}.
        slots:
          id: path.id
          addons: requestBody.addons
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{id}/billing/{plan}/addons'].get
  update:
    x-apievangelist-phrasing:
      intent: List add-ons available for a plan
      effect: read
      questions:
      - Which add-ons can I buy on top of a given plan?
      - What extras are available for the plan my org is considering?
      instructions:
      - text: List the add-ons available for plan {plan} in organization {id}.
        slots:
          plan: path.plan
          id: path.id
      - text: Show purchasable add-ons for org {id} on the {plan} plan.
        slots:
          id: path.id
          plan: path.plan
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{id}/checkout'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a billing checkout for a plan
      effect: write
      questions:
      - How do I pay for a plan and start a checkout for my org?
      - Can I check out with add-ons and a separate billing email?
      instructions:
      - text: Start a checkout for organization {id} on plan {plan}.
        slots:
          id: path.id
          plan: requestBody.plan
      - text: Check out org {id} on plan {plan} billed to {billingName} at {billingEmail}.
        slots:
          id: path.id
          plan: requestBody.plan
          billingName: requestBody.billingName
          billingEmail: requestBody.billingEmail
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{id}/csv-audit-logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Export the audit log as CSV
      effect: read
      questions:
      - Can I download my org's audit log as a spreadsheet?
      - Is there a CSV export of audit events for compliance review?
      instructions:
      - text: Export the audit log for organization {id} as CSV.
        slots:
          id: path.id
      - text: Download org {id}'s audit events in CSV format.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{id}/feature-statuses'].get
  update:
    x-apievangelist-phrasing:
      intent: Check which features are enabled
      effect: read
      questions:
      - Which features are turned on for my organization?
      - Can I tell if a feature is enabled on our current plan?
      instructions:
      - text: Show the feature statuses for organization {id}.
        slots:
          id: path.id
      - text: Check which features are enabled or disabled in org {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{id}/invitees'].get
  update:
    x-apievangelist-phrasing:
      intent: List pending invitations
      effect: read
      questions:
      - Who has been invited to my org but not joined yet?
      - Can I see the outstanding invitations for our organization?
      instructions:
      - text: List the pending invitees for organization {id}.
        slots:
          id: path.id
      - text: Show everyone with an open invite to org {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{id}/join'].post
  update:
    x-apievangelist-phrasing:
      intent: Accept an invitation to join an organization
      effect: write
      questions:
      - How do I accept an invite to join an organization?
      - I was invited to an org — how do I become a member?
      instructions:
      - text: Join organization {id}.
        slots:
          id: path.id
      - text: Accept my pending invitation to org {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{id}/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List organization members
      effect: read
      questions:
      - Who are the current members of my organization?
      - Can I list everyone who has already joined our org?
      instructions:
      - text: List the members of organization {id}.
        slots:
          id: path.id
      - text: Show all joined users in org {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{id}/members/invite'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite people to the organization
      effect: write
      questions:
      - How do I invite teammates to my organization by email?
      - Can I choose a role for people when I invite them?
      instructions:
      - text: Invite {emails} to organization {id}.
        slots:
          emails: requestBody.emails
          id: path.id
      - text: Invite {emails} to org {id} with the {role} role.
        slots:
          emails: requestBody.emails
          id: path.id
          role: requestBody.role
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{id}/members/uninvite'].post
  update:
    x-apievangelist-phrasing:
      intent: Revoke a pending invitation
      effect: destructive
      questions:
      - Can I cancel an invitation I sent to the wrong email?
      - How do I withdraw someone's pending invite before they join?
      instructions:
      - text: Revoke the invitation for {email} in organization {id}.
        slots:
          email: requestBody.email
          id: path.id
      - text: Uninvite {email} from org {id}.
        slots:
          email: requestBody.email
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{id}/members/{member_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a member's organization role
      effect: write
      questions:
      - How do I promote an org member to admin?
      - Can I change the role of someone already in my organization?
      instructions:
      - text: Set member {member_id} in organization {id} to the {role} role.
        slots:
          member_id: path.member_id
          id: path.id
          role: requestBody.role
      - text: Change the org role of {member_id} in {id}.
        slots:
          member_id: path.member_id
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{id}/members/{member_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a member from the organization
      effect: destructive
      questions:
      - How do I remove someone who has left the company from our org?
      - Can I kick a member out of my organization?
      instructions:
      - text: Remove member {member_id} from organization {id}.
        slots:
          member_id: path.member_id
          id: path.id
      - text: Take user {member_id} out of org {id}.
        slots:
          member_id: path.member_id
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{id}/oidc-map'].get
  update:
    x-apievangelist-phrasing:
      intent: View the OIDC group-to-role map
      effect: read
      questions:
      - How are my identity provider groups mapped to organization roles?
      - Which OIDC claims grant which org role today?
      instructions:
      - text: Show the OIDC role mapping for organization {id}.
        slots:
          id: path.id
      - text: Fetch the OIDC group-to-role map for org {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{id}/oidc-map'].put
  update:
    x-apievangelist-phrasing:
      intent: Update the OIDC group-to-role map
      effect: write
      questions:
      - Can I map an SSO group to the admin role in my org?
      - How do I change which OIDC groups get which organization role?
      instructions:
      - text: Replace the OIDC role mapping for organization {id} with {entries}.
        slots:
          id: path.id
          entries: requestBody.entries
      - text: Update org {id}'s OIDC group-to-role entries.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{id}/permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my permissions in an organization
      effect: read
      questions:
      - What am I allowed to do in this organization?
      - Which actions do my permissions cover in a given org?
      instructions:
      - text: Show my permissions in organization {id}.
        slots:
          id: path.id
      - text: List what actions I'm permitted to take in org {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{id}/reject'].post
  update:
    x-apievangelist-phrasing:
      intent: Decline an invitation to an organization
      effect: write
      questions:
      - Can I turn down an invite to join an organization?
      - How do I decline an org invitation I don't want?
      instructions:
      - text: Decline the invitation to organization {id}.
        slots:
          id: path.id
      - text: Reject my pending invite from org {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{id}/role'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my role in an organization
      effect: read
      questions:
      - What role do I have in this organization — owner, admin or member?
      - Am I an admin in the org I'm currently using?
      instructions:
      - text: Show my role in organization {id}.
        slots:
          id: path.id
      - text: Tell me whether I'm an owner, admin or member of org {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{id}/sso/configuration'].get
  update:
    x-apievangelist-phrasing:
      intent: View the SSO configuration
      effect: read
      questions:
      - How is single sign-on currently configured for my organization?
      - Is SSO enforced for our org, and which identity provider is used?
      instructions:
      - text: Show the SSO configuration for organization {id}.
        slots:
          id: path.id
      - text: Fetch org {id}'s single sign-on settings.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{id}/sso/configuration'].put
  update:
    x-apievangelist-phrasing:
      intent: Set up or update SSO
      effect: write
      questions:
      - How do I connect Okta, Azure AD, Google Workspace or SAML for SSO?
      - Can I enforce SSO and automatically add members who sign in?
      instructions:
      - text: Configure Okta SSO for organization {id} using {okta}.
        slots:
          id: path.id
          okta: requestBody.okta
      - text: Set up SAML single sign-on on org {id} with {saml}.
        slots:
          id: path.id
          saml: requestBody.saml
      - text: Turn SSO enforcement to {enforceSso} for organization {id}.
        slots:
          enforceSso: requestBody.enforceSso
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{id}/sso/configuration'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove the SSO configuration
      effect: destructive
      questions:
      - Can I disconnect single sign-on from my organization?
      - How do I delete an SSO setup that is misconfigured?
      instructions:
      - text: Delete the SSO configuration for organization {id}.
        slots:
          id: path.id
      - text: Remove single sign-on from org {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{id}/workspaces/{workspace_id}/apikeys'].get
  update:
    x-apievangelist-phrasing:
      intent: List a workspace's API keys
      effect: read
      questions:
      - Which API keys are scoped to a particular workspace?
      - Can I audit the keys created inside one workspace?
      instructions:
      - text: List API keys for workspace {workspace_id} in organization {id}.
        slots:
          workspace_id: path.workspace_id
          id: path.id
      - text: Show the workspace-scoped keys in {workspace_id}.
        slots:
          workspace_id: path.workspace_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{id}/workspaces/{workspace_id}/apikeys'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a workspace-scoped API key
      effect: write
      questions:
      - How do I create an API key limited to a single workspace?
      - Can a workspace API key have an expiry and restricted permissions?
      instructions:
      - text: Create an API key for workspace {workspace_id} in organization {id}.
        slots:
          workspace_id: path.workspace_id
          id: path.id
      - text: Issue a workspace key in {workspace_id} of org {id} expiring in {expireInDuration} with permissions {permissions}.
        slots:
          workspace_id: path.workspace_id
          id: path.id
          expireInDuration: requestBody.expireInDuration
          permissions: requestBody.permissions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{organization_id}/billing/subscription/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel the organization's subscription
      effect: destructive
      questions:
      - How do I cancel our paid Akuity subscription?
      - Can I stop billing for my organization entirely?
      instructions:
      - text: Cancel the subscription for organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: End paid billing on org {organization_id}.
        slots:
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{organization_id}/custom-roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List organization custom roles
      effect: read
      questions:
      - What custom roles have been defined at the organization level?
      - Can I page through our org's custom roles?
      instructions:
      - text: List the custom roles in organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: Show {limit} org custom roles in {organization_id} starting at offset {offset}.
        slots:
          limit: query.limit
          organization_id: path.organization_id
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{organization_id}/custom-roles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an organization custom role
      effect: write
      questions:
      - How do I define a custom role with its own policy for the whole org?
      - Can I create a least-privilege role for our organization?
      instructions:
      - text: Create an org custom role named {name} in {organization_id} with policy {policy}.
        slots:
          name: requestBody.name
          organization_id: path.organization_id
          policy: requestBody.policy
      - text: Add organization-wide role {name} described as {description} to {organization_id}.
        slots:
          name: requestBody.name
          description: requestBody.description
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{organization_id}/custom-roles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization custom role
      effect: read
      questions:
      - What policy does a specific org-level custom role grant?
      - Can I inspect one of our organization's custom roles?
      instructions:
      - text: Show org custom role {id} in organization {organization_id}.
        slots:
          id: path.id
          organization_id: path.organization_id
      - text: Fetch the policy of organization role {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{organization_id}/custom-roles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an organization custom role
      effect: destructive
      questions:
      - How do I remove an org-level custom role we no longer use?
      - Can I delete a custom role from the organization?
      instructions:
      - text: Delete org custom role {id} from organization {organization_id}.
        slots:
          id: path.id
          organization_id: path.organization_id
      - text: Remove organization role {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{organization_id}/custom-roles/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an organization custom role
      effect: write
      questions:
      - Can I change the policy on an existing org custom role?
      - How do I rename an organization-level custom role?
      instructions:
      - text: Update org custom role {id} in {organization_id} to policy {policy}.
        slots:
          id: path.id
          organization_id: path.organization_id
          policy: requestBody.policy
      - text: Rename organization role {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{organization_id}/domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List verified organization domains
      effect: read
      questions:
      - Which email domains are verified for my organization?
      - What domains has our org claimed?
      instructions:
      - text: List the domains for organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: Show org {organization_id}'s verified domains.
        slots:
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{organization_id}/domains'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify domains for the organization
      effect: write
      questions:
      - How do I verify that our company domain belongs to my org?
      - Can I claim several email domains for the organization at once?
      instructions:
      - text: Verify domains {domains} for organization {organization_id}.
        slots:
          domains: requestBody.domains
          organization_id: path.organization_id
      - text: Claim {domains} as org {organization_id}'s domains.
        slots:
          domains: requestBody.domains
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{organization_id}/domains/{domain}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a domain from the organization
      effect: destructive
      questions:
      - Can I remove a domain we no longer own from our org?
      - How do I unclaim an organization domain?
      instructions:
      - text: Remove domain {domain} from organization {organization_id}.
        slots:
          domain: path.domain
          organization_id: path.organization_id
      - text: Delete the {domain} domain from org {organization_id}.
        slots:
          domain: path.domain
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{organization_id}/teams-oidc-map'].get
  update:
    x-apievangelist-phrasing:
      intent: View the OIDC group-to-team map
      effect: read
      questions:
      - Which identity provider groups are mapped to which teams?
      - How are OIDC claims assigning people to teams in my org?
      instructions:
      - text: Show the team OIDC mapping for organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: Fetch the OIDC group-to-team map for org {organization_id}.
        slots:
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{organization_id}/teams-oidc-map'].put
  update:
    x-apievangelist-phrasing:
      intent: Update the OIDC group-to-team map
      effect: write
      questions:
      - Can I automatically put SSO group members into a team?
      - How do I change which OIDC groups map to which teams?
      instructions:
      - text: Replace the team OIDC mapping for organization {organization_id} with {entries}.
        slots:
          organization_id: path.organization_id
          entries: requestBody.entries
      - text: Update org {organization_id}'s OIDC group-to-team entries.
        slots:
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{organization_id}/users-mfa-status'].get
  update:
    x-apievangelist-phrasing:
      intent: List members' MFA status
      effect: read
      questions:
      - Which users in my org haven't set up multi-factor authentication?
      - Can I see MFA enrollment for everyone in the organization?
      instructions:
      - text: List MFA status for all users in organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: Show who has MFA enabled in org {organization_id}.
        slots:
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{organization_id}/users/{email}/mfa/reset'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset a user's MFA
      effect: write
      questions:
      - A teammate lost their authenticator — can I reset their MFA?
      - How do I force a user to re-enroll in multi-factor auth?
      instructions:
      - text: Reset MFA for {email} in organization {organization_id}.
        slots:
          email: path.email
          organization_id: path.organization_id
      - text: Request an MFA reset for user {email}.
        slots:
          email: path.email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organizations/{organization_id}/workspaces/{workspace_id}/custom-roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List a workspace's custom roles
      effect: read
      questions:
      - Which custom roles exist inside a specific workspace?
      - Can I list roles defined only for one workspace?
      instructions:
      - text: List custom roles in workspace {workspace_id} of organization {organization_id}.
        slots:
          workspace_id: path.workspace_id
          organization_id: path.organization_id
      - text: Show {limit} workspace roles in {workspace_id}.
        slots:
          limit: query.limit
          workspace_id: path.workspace_id
      method: generated
      generated: '2026-09-26'


# --- truncated at 32 KB (143 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/akuity/refs/heads/main/overlays/akuity-organizationservice-api-phrasing-overlay.yaml