API Evangelist conversational phrasing for Elastic Cloud Enterprise Organizations API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Elastic Cloud Enterprise Organizations API
  version: 1.0.0
extends: openapi/elk-stack-organizations-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: 23
- target: $.paths['/organizations'].get
  update:
    x-apievangelist-phrasing:
      intent: List the organizations I belong to
      effect: read
      questions:
      - Which Elastic Cloud organizations does my user have access to?
      - Can I see every organization available to my account in one call?
      instructions:
      - text: List all the organizations my user can access.
      - text: Show me which cloud organizations are available to the current user.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/invitations/{invitation_token}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up an organization invitation by token
      effect: read
      questions:
      - What organization does this invitation token belong to?
      - Can I check the details of a single invite before I accept it?
      instructions:
      - text: Get the organization invitation with token {invitation_token}.
        slots:
          invitation_token: path.invitation_token
      - text: Show me who invited me and to which organization using invite token {invitation_token}.
        slots:
          invitation_token: path.invitation_token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization's details
      effect: read
      questions:
      - How do I fetch the name and settings of one organization by its id?
      - What information is stored about my Elastic Cloud organization?
      instructions:
      - text: Fetch organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: Show the name, contacts and alert settings of organization {organization_id}.
        slots:
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an organization's name and contacts
      effect: write
      questions:
      - Can I rename my organization or change its billing contacts?
      - Is there a way to restrict which email domains can receive organization notifications?
      - How do I turn default disk usage alerts on for my whole organization?
      instructions:
      - text: Rename organization {organization_id} to {name}.
        slots:
          organization_id: path.organization_id
          name: requestBody.name
      - text: Set the billing contacts on organization {organization_id} to {billing_contacts}.
        slots:
          organization_id: path.organization_id
          billing_contacts: requestBody.billing_contacts
      - text: Change the operational contacts of organization {organization_id} to {operational_contacts} using the deprecated update endpoint.
        slots:
          organization_id: path.organization_id
          operational_contacts: requestBody.operational_contacts
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's claimed domains
      effect: read
      questions:
      - Which email domains has my organization already claimed?
      - How can I see the verified domain claims for an organization?
      instructions:
      - text: List the domain claims for organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: Show which domains organization {organization_id} owns.
        slots:
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/domains'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a claimed domain from an organization
      effect: destructive
      questions:
      - How do I give up a domain my organization previously claimed?
      - Can I delete a domain claim that is no longer ours?
      instructions:
      - text: Delete the domain claim {domain_claim_request} from organization {organization_id}.
        slots:
          domain_claim_request: requestBody.domain_claim_request
          organization_id: path.organization_id
      - text: Unclaim domain {domain_claim_request} for org {organization_id}.
        slots:
          domain_claim_request: requestBody.domain_claim_request
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/domains/_generate_verification_code'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a domain verification code
      effect: write
      questions:
      - How do I get the verification code I need to prove we own a domain?
      - What value do I put in DNS to start a domain claim challenge?
      instructions:
      - text: Generate a verification code to claim domain {domain_claim_request} for organization {organization_id}.
        slots:
          domain_claim_request: requestBody.domain_claim_request
          organization_id: path.organization_id
      - text: Start the domain claim challenge for {domain_claim_request} in org {organization_id}.
        slots:
          domain_claim_request: requestBody.domain_claim_request
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/domains/_verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a domain claim challenge
      effect: write
      questions:
      - Once the verification code is published, how do I complete the domain claim?
      - Can I check that our domain ownership challenge now passes?
      instructions:
      - text: Verify the domain claim for {domain_claim_request} on organization {organization_id}.
        slots:
          domain_claim_request: requestBody.domain_claim_request
          organization_id: path.organization_id
      - text: Complete the ownership check for domain {domain_claim_request} now that the code is in place for org {organization_id}.
        slots:
          domain_claim_request: requestBody.domain_claim_request
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/idp'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization's SSO identity provider
      effect: read
      questions:
      - What SAML identity provider is configured for my organization?
      - Is single sign-on enabled for our organization right now?
      instructions:
      - text: Show the IdP configuration for organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: Check whether SSO is enabled on org {organization_id}.
        slots:
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/idp'].put
  update:
    x-apievangelist-phrasing:
      intent: Set up SAML single sign-on for an organization
      effect: write
      questions:
      - How do I connect our SAML identity provider so members log in with SSO?
      - Can I set a login identifier prefix when configuring organization SSO?
      instructions:
      - text: Set up SAML SSO for organization {organization_id} with IdP settings {saml_idp} and login prefix {login_identifier_prefix}, enabled {enabled}.
        slots:
          organization_id: path.organization_id
          saml_idp: requestBody.saml_idp
          login_identifier_prefix: requestBody.login_identifier_prefix
          enabled: requestBody.enabled
      - text: Configure org {organization_id} to use identity provider {saml_idp} with SSO turned on ({enabled}) and prefix {login_identifier_prefix}.
        slots:
          organization_id: path.organization_id
          saml_idp: requestBody.saml_idp
          enabled: requestBody.enabled
          login_identifier_prefix: requestBody.login_identifier_prefix
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/idp'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an organization's SSO identity provider
      effect: destructive
      questions:
      - How do I tear down single sign-on for my organization?
      - Can I remove the SAML identity provider we configured?
      instructions:
      - text: Tear down the IdP for organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: Remove SAML SSO from org {organization_id}.
        slots:
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/idp/metadata.xml'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the SAML service provider metadata.xml
      effect: read
      questions:
      - Where do I get the SAML metadata.xml to configure our identity provider?
      - What service provider metadata does my IdP need for organization SSO?
      instructions:
      - text: Download the SAML2 metadata.xml for organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: Get the service provider metadata file I should load into our IdP for org {organization_id}.
        slots:
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/invitations'].get
  update:
    x-apievangelist-phrasing:
      intent: List open invitations to an organization
      effect: read
      questions:
      - Which invitations to my organization are still pending?
      - Who has been invited to our organization but not joined yet?
      instructions:
      - text: List the open invitations for organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: Show pending invites to org {organization_id}.
        slots:
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/invitations'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite people to an organization
      effect: write
      questions:
      - How do I invite teammates to my organization by email?
      - Can I set how long an organization invitation stays valid?
      - Can I assign roles to people at the moment I invite them?
      instructions:
      - text: Invite {emails} to organization {organization_id}.
        slots:
          emails: requestBody.emails
          organization_id: path.organization_id
      - text: Send invitations to {emails} for org {organization_id} that expire in {expires_in}.
        slots:
          emails: requestBody.emails
          organization_id: path.organization_id
          expires_in: requestBody.expires_in
      - text: Invite {emails} to org {organization_id} with role assignments {role_assignments}.
        slots:
          emails: requestBody.emails
          organization_id: path.organization_id
          role_assignments: requestBody.role_assignments
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/invitations/{invitation_tokens}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke organization invitations
      effect: destructive
      questions:
      - How do I cancel an invitation I sent by mistake?
      - Can I revoke several pending organization invites at once?
      instructions:
      - text: Delete invitations {invitation_tokens} from organization {organization_id}.
        slots:
          invitation_tokens: path.invitation_tokens
          organization_id: path.organization_id
      - text: Revoke the pending invites {invitation_tokens} to org {organization_id}.
        slots:
          invitation_tokens: path.invitation_tokens
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List the members of an organization
      effect: read
      questions:
      - Who belongs to my organization?
      - How can I get the list of users in an organization?
      instructions:
      - text: List the members of organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: Show every user that belongs to org {organization_id}.
        slots:
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/members/{user_ids}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove users from an organization
      effect: destructive
      questions:
      - How do I remove someone from my organization?
      - Can I force-remove members from an organization in one request?
      instructions:
      - text: Remove users {user_ids} from organization {organization_id}.
        slots:
          user_ids: path.user_ids
          organization_id: path.organization_id
      - text: Force-delete the memberships of {user_ids} in org {organization_id}.
        slots:
          user_ids: path.user_ids
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/role_mappings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization's SSO role mappings
      effect: read
      questions:
      - Which roles do SSO users get when they log in to our organization?
      - What role mappings are configured for my organization?
      instructions:
      - text: Get the role mappings for organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: Show how SSO logins map to roles in org {organization_id}.
        slots:
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/role_mappings'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace all SSO role mappings
      effect: write
      questions:
      - How do I replace the whole set of SSO role mappings at once?
      - Can I overwrite every role assignment applied at SSO login?
      instructions:
      - text: Replace the role mappings of organization {organization_id} with {mappings}.
        slots:
          organization_id: path.organization_id
          mappings: requestBody.mappings
      - text: Overwrite all SSO role assignments for org {organization_id} using {mappings}.
        slots:
          organization_id: path.organization_id
          mappings: requestBody.mappings
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/role_mappings'].post
  update:
    x-apievangelist-phrasing:
      intent: Add SSO role mappings
      effect: write
      questions:
      - Can I add a new SSO role mapping without replacing the existing ones?
      - How do I append role assignments for SSO logins?
      instructions:
      - text: Add role mappings {mappings} to organization {organization_id}.
        slots:
          mappings: requestBody.mappings
          organization_id: path.organization_id
      - text: Append {mappings} to the existing SSO mappings of org {organization_id}.
        slots:
          mappings: requestBody.mappings
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/role_mappings'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete all SSO role mappings
      effect: destructive
      questions:
      - How do I clear every role mapping from my organization?
      - Can I wipe out all SSO role assignments in one go?
      instructions:
      - text: Delete all role mappings for organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: Clear every SSO role mapping in org {organization_id}.
        slots:
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/role_mappings/{role_names}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete specific SSO role mappings by name
      effect: destructive
      questions:
      - Can I delete just one named role mapping and keep the rest?
      - How do I remove particular SSO role mappings by their names?
      instructions:
      - text: Delete the role mappings named {role_names} from organization {organization_id}.
        slots:
          role_names: path.role_names
          organization_id: path.organization_id
      - text: Remove only mapping {role_names} in org {organization_id}.
        slots:
          role_names: path.role_names
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/role_mappings/{role_name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update one SSO role mapping by name
      effect: write
      questions:
      - How do I edit a single existing role mapping by its name?
      - Can I change what one named SSO mapping grants?
      instructions:
      - text: Update role mapping {role_name} in organization {organization_id} to {mapping}.
        slots:
          role_name: path.role_name
          organization_id: path.organization_id
          mapping: requestBody.mapping
      - text: Change the named mapping {role_name} for org {organization_id} so it becomes {mapping}.
        slots:
          role_name: path.role_name
          organization_id: path.organization_id
          mapping: requestBody.mapping
      method: generated
      generated: '2026-09-26'