# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Auth0 Management Organizations API
  version: 1.0.0
extends: openapi/auth0-organizations-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: 35
- target: $.paths['/organizations'].get
  update:
    x-apievangelist-phrasing:
      intent: List all organizations in the tenant
      effect: read
      questions:
      - How do I list every organization in my Auth0 tenant?
      - Can I page through more than a thousand organizations using checkpoint pagination?
      - Which organizations exist in my tenant, sorted by name?
      instructions:
      - text: List all organizations in my tenant.
      - text: List organizations sorted by {sort}, {take} at a time.
        slots:
          sort: query.sort
          take: query.take
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an organization
      effect: write
      questions:
      - How do I create a new organization for a B2B customer in Auth0?
      - Can I set branding and metadata when I first create an organization?
      instructions:
      - text: Create a new organization named {name}.
        slots:
          name: requestBody.name
      - text: Create organization {name} with the display name {display_name}.
        slots:
          name: requestBody.name
          display_name: requestBody.display_name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/name/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up an organization by its name
      effect: read
      questions:
      - How can I find an organization when I only know its name, not its ID?
      - Is there a way to fetch an organization's details by name?
      instructions:
      - text: Look up the organization named {name}.
        slots:
          name: path.name
      - text: Get the organization details for the name {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization by ID
      effect: read
      questions:
      - Can I retrieve a single organization's details using its ID?
      - What branding and metadata does a specific organization ID have?
      instructions:
      - text: Get organization {id}.
        slots:
          id: path.id
      - text: Show me the settings of organization ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an organization
      effect: destructive
      questions:
      - What happens to members when I delete an organization?
      - Can I permanently remove an organization from my tenant?
      instructions:
      - text: Delete organization {id}.
        slots:
          id: path.id
      - text: Permanently remove the organization with ID {id} from my tenant.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an organization's details
      effect: write
      questions:
      - How do I rename an existing organization or change its display name?
      - Can I update the branding or metadata of an organization I already created?
      instructions:
      - text: Change the display name of organization {id} to {display_name}.
        slots:
          id: path.id
          display_name: requestBody.display_name
      - text: Update the metadata on organization {id} to {metadata}.
        slots:
          id: path.id
          metadata: requestBody.metadata
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{id}/client-grants'].get
  update:
    x-apievangelist-phrasing:
      intent: List client grants tied to an organization
      effect: read
      questions:
      - Which client grants are associated with a given organization?
      - Can I filter an organization's client grants by audience or client ID?
      instructions:
      - text: List the client grants associated with organization {id}.
        slots:
          id: path.id
      - text: Show organization {id}'s client grants for the audience {audience}.
        slots:
          id: path.id
          audience: query.audience
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{id}/client-grants'].post
  update:
    x-apievangelist-phrasing:
      intent: Associate a client grant with an organization
      effect: write
      questions:
      - Is it possible to attach an existing client grant to an organization?
      - Can a machine-to-machine client grant be scoped to one organization?
      instructions:
      - text: Associate client grant {grant_id} with organization {id}.
        slots:
          grant_id: requestBody.grant_id
          id: path.id
      - text: Link grant {grant_id} to the organization {id}.
        slots:
          grant_id: requestBody.grant_id
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{id}/client-grants/{grant_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a client grant from an organization
      effect: destructive
      questions:
      - What's the call to detach a client grant from an organization?
      - Can I stop a client grant from applying to one organization without deleting the grant?
      instructions:
      - text: Remove client grant {grant_id} from organization {id}.
        slots:
          grant_id: path.grant_id
          id: path.id
      - text: Unlink grant {grant_id} from the organization {id}.
        slots:
          grant_id: path.grant_id
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{id}/connections'].get
  update:
    x-apievangelist-phrasing:
      intent: List connections associated with an organization
      effect: read
      questions:
      - Which connections are associated with an organization, including disabled ones?
      - Can I filter an organization's associated connections by whether they are enabled?
      instructions:
      - text: List all connections associated with organization {id}.
        slots:
          id: path.id
      - text: List the connections of organization {id} where enabled is {is_enabled}.
        slots:
          id: path.id
          is_enabled: query.is_enabled
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{id}/connections'].post
  update:
    x-apievangelist-phrasing:
      intent: Associate a connection with an organization
      effect: write
      questions:
      - How do I associate a connection with an organization and set its access level?
      - Can I enable signup through a connection when associating it with an organization?
      instructions:
      - text: Associate connection {connection_id} with organization {id}.
        slots:
          connection_id: requestBody.connection_id
          id: path.id
      - text: Associate connection {connection_id} with organization {id} at access level {organization_access_level}.
        slots:
          connection_id: requestBody.connection_id
          id: path.id
          organization_access_level: requestBody.organization_access_level
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{id}/connections/{connection_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one connection associated with an organization
      effect: read
      questions:
      - What access level and signup setting does one associated connection have in an organization?
      - Is a particular connection associated with this organization?
      instructions:
      - text: Get the association of connection {connection_id} with organization {id}.
        slots:
          connection_id: path.connection_id
          id: path.id
      - text: Show the organization access level of connection {connection_id} in organization {id}.
        slots:
          connection_id: path.connection_id
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{id}/connections/{connection_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a connection association from an organization
      effect: destructive
      questions:
      - How do I remove an associated connection from an organization using the connections endpoint?
      - Does removing a connection association from an organization delete the connection itself?
      instructions:
      - text: Remove the association between connection {connection_id} and organization {id}.
        slots:
          connection_id: path.connection_id
          id: path.id
      - text: Delete connection {connection_id} from organization {id}'s associated connections.
        slots:
          connection_id: path.connection_id
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{id}/connections/{connection_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a connection association on an organization
      effect: write
      questions:
      - How do I change the organization access level of an associated connection?
      - Can I rename how an associated connection appears inside one organization?
      instructions:
      - text: Set the access level of connection {connection_id} in organization {id} to {organization_access_level}.
        slots:
          connection_id: path.connection_id
          id: path.id
          organization_access_level: requestBody.organization_access_level
      - text: Rename associated connection {connection_id} in organization {id} to {organization_connection_name}.
        slots:
          connection_id: path.connection_id
          id: path.id
          organization_connection_name: requestBody.organization_connection_name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{id}/discovery-domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's discovery domains
      effect: read
      questions:
      - Which discovery domains are registered for an organization?
      - Why might a discovery domain I just added not show up in the list yet?
      instructions:
      - text: List the discovery domains for organization {id}.
        slots:
          id: path.id
      - text: Show the next {take} discovery domains of organization {id}.
        slots:
          take: query.take
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{id}/discovery-domains'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a discovery domain to an organization
      effect: write
      questions:
      - How do I register an email domain so users are routed to the right organization?
      - Can I add a discovery domain as pending before it is verified?
      instructions:
      - text: Add the discovery domain {domain} to organization {id}.
        slots:
          domain: requestBody.domain
          id: path.id
      - text: Create discovery domain {domain} for organization {id} with status {status}.
        slots:
          domain: requestBody.domain
          id: path.id
          status: requestBody.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{id}/discovery-domains/name/{discovery_domain}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a discovery domain by its domain name
      effect: read
      questions:
      - Can I check a discovery domain's verification status using the domain name itself?
      - Can I fetch an organization's discovery domain without knowing its ID?
      instructions:
      - text: Look up discovery domain {discovery_domain} in organization {id}.
        slots:
          discovery_domain: path.discovery_domain
          id: path.id
      - text: Check whether the domain name {discovery_domain} is verified for organization {id}.
        slots:
          discovery_domain: path.discovery_domain
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{id}/discovery-domains/{discovery_domain_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a discovery domain by its ID
      effect: read
      questions:
      - How do I retrieve one discovery domain record using its discovery domain ID?
      - What status does a specific discovery domain ID currently have?
      instructions:
      - text: Get discovery domain ID {discovery_domain_id} of organization {id}.
        slots:
          discovery_domain_id: path.discovery_domain_id
          id: path.id
      - text: Show the record for discovery domain ID {discovery_domain_id} in organization {id}.
        slots:
          discovery_domain_id: path.discovery_domain_id
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{id}/discovery-domains/{discovery_domain_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an organization discovery domain
      effect: destructive
      questions:
      - Is there a way to remove a discovery domain from an organization?
      - Can a deleted discovery domain be restored?
      instructions:
      - text: Delete discovery domain {discovery_domain_id} from organization {id}.
        slots:
          discovery_domain_id: path.discovery_domain_id
          id: path.id
      - text: Remove discovery domain ID {discovery_domain_id} so it no longer routes users to organization {id}.
        slots:
          discovery_domain_id: path.discovery_domain_id
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{id}/discovery-domains/{discovery_domain_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Verify or update a discovery domain
      effect: write
      questions:
      - How do I mark a discovery domain as verified?
      - Can I turn off organization discovery for a domain without deleting it?
      instructions:
      - text: Set discovery domain {discovery_domain_id} in organization {id} to status {status}.
        slots:
          discovery_domain_id: path.discovery_domain_id
          id: path.id
          status: requestBody.status
      - text: Set use for organization discovery to {use_for_organization_discovery} on domain {discovery_domain_id} of organization {id}.
        slots:
          use_for_organization_discovery: requestBody.use_for_organization_discovery
          discovery_domain_id: path.discovery_domain_id
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{id}/enabled_connections'].get
  update:
    x-apievangelist-phrasing:
      intent: List connections enabled for an organization
      effect: read
      questions:
      - Which login connections are currently enabled for an organization?
      - Does each enabled connection auto-assign membership on login?
      instructions:
      - text: List the enabled connections for organization {id}.
        slots:
          id: path.id
      - text: Show which connections organization {id} members can log in with.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{id}/enabled_connections'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable a connection for an organization
      effect: write
      questions:
      - How do I let an organization's members log in with an existing connection?
      - Can I have membership granted automatically when someone logs in through an enabled connection?
      instructions:
      - text: Enable connection {connection_id} for organization {id}.
        slots:
          connection_id: requestBody.connection_id
          id: path.id
      - text: Enable connection {connection_id} on organization {id} with assign membership on login set to {assign_membership_on_login}.
        slots:
          connection_id: requestBody.connection_id
          id: path.id
          assign_membership_on_login: requestBody.assign_membership_on_login
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{id}/enabled_connections/{connectionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an enabled connection for an organization
      effect: read
      questions:
      - What settings does one connection enabled on an organization have?
      - Is a given connection shown as a button on an organization's login page?
      instructions:
      - text: Get enabled connection {connectionId} for organization {id}.
        slots:
          connectionId: path.connectionId
          id: path.id
      - text: Show the enabled-connection settings of {connectionId} on organization {id}.
        slots:
          connectionId: path.connectionId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{id}/enabled_connections/{connectionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Disable a connection for an organization
      effect: destructive
      questions:
      - How do I stop an organization's members from logging in with a certain connection?
      - Will disabling a connection on an organization remove it from my tenant?
      instructions:
      - text: Disable connection {connectionId} for organization {id}.
        slots:
          connectionId: path.connectionId
          id: path.id
      - text: Turn off login through {connectionId} for members of organization {id}.
        slots:
          connectionId: path.connectionId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{id}/enabled_connections/{connectionId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an enabled connection on an organization
      effect: write
      questions:
      - How do I allow signups through a connection that's already enabled on an organization?
      - Can I hide an enabled connection's button on the organization login page?
      instructions:
      - text: Set signup enabled to {is_signup_enabled} for enabled connection {connectionId} on organization {id}.
        slots:
          is_signup_enabled: requestBody.is_signup_enabled
          connectionId: path.connectionId
          id: path.id
      - text: Set show as button to {show_as_button} for enabled connection {connectionId} in organization {id}.
        slots:
          show_as_button: requestBody.show_as_button
          connectionId: path.connectionId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{id}/invitations'].get
  update:
    x-apievangelist-phrasing:
      intent: List invitations sent for an organization
      effect: read
      questions:
      - Who has been invited to join an organization and when do the invites expire?
      - Can I sort an organization's pending invitations by creation date?
      instructions:
      - text: List the invitations for organization {id}.
        slots:
          id: path.id
      - text: List organization {id}'s invitations sorted by {sort}.
        slots:
          id: path.id
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{id}/invitations'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite a user to an organization
      effect: write
      questions:
      - How do I email someone an invitation to join an organization?
      - Can I assign roles and set an expiry when inviting a user to an organization?
      instructions:
      - text: Invite {invitee} to organization {id} from {inviter} using client {client_id}.
        slots:
          invitee: requestBody.invitee
          id: path.id
          inviter: requestBody.inviter
          client_id: requestBody.client_id
      - text: Invite {invitee} to organization {id} via app {client_id} on behalf of {inviter} with roles {roles}.
        slots:
          invitee: requestBody.invitee
          id: path.id
          client_id: requestBody.client_id
          inviter: requestBody.inviter
          roles: requestBody.roles
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{id}/invitations/{invitation_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a specific organization invitation
      effect: read
      questions:
      - How do I look up the details and invitation URL of one invitation?
      - Has a particular organization invitation expired yet?
      instructions:
      - text: Get invitation {invitation_id} for organization {id}.
        slots:
          invitation_id: path.invitation_id
          id: path.id
      - text: Show the invite link and expiry for invitation {invitation_id} in organization {id}.
        slots:
          invitation_id: path.invitation_id
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{id}/invitations/{invitation_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel an organization invitation
      effect: destructive
      questions:
      - Can I revoke an invitation I sent by mistake?
      - Can I cancel an outstanding invite to an organization?
      instructions:
      - text: Delete invitation {invitation_id} from organization {id}.
        slots:
          invitation_id: path.invitation_id
          id: path.id
      - text: Cancel the pending invite {invitation_id} to organization {id}.
        slots:
          invitation_id: path.invitation_id
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{id}/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List members of an organization
      effect: read
      questions:
      - Who are the members of a specific organization?
      - Why might a newly added user not appear in an organization's member list yet?
      instructions:
      - text: List the members of organization {id}.
        slots:
          id: path.id
      - text: List organization {id} members returning only the fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{id}/members'].post
  update:
    x-apievangelist-phrasing:
      intent: Add existing users to an organization
      effect: write
      questions:
      - How do I add users who already exist in my tenant to an organization?
      - Can I add several members to an organization in one request?
      instructions:
      - text: Add users {members} as members of organization {id}.
        slots:
          members: requestBody.members
          id: path.id
      - text: Make user {members} a member of organization {id}.
        slots:
          members: requestBody.members
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{id}/members'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove members from an organization
      effect: destructive
      questions:
      - How do I remove users from an organization's membership?
      - Can I take several people out of an organization at once?
      instructions:
      - text: Remove users {members} from organization {id}.
        slots:
          members: requestBody.members
          id: path.id
      - text: Revoke organization {id} membership for {members}.
        slots:
          id: path.id
          members: requestBody.members
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{id}/members/{user_id}/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List a member's roles within an organization
      effect: read
      questions:
      - What roles does a user have inside one specific organization?
      - Are organization-scoped roles separate from a user's tenant-wide roles?
      instructions:
      - text: List the roles of user {user_id} in organization {id}.
        slots:
          user_id: path.user_id
          id: path.id
      - text: Show which organization roles member {user_id} holds in {id}.
        slots:
          user_id: path.user_id
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{id}/members/{user_id}/roles'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign roles to an organization member
      effect: write
      questions:
      - How do I give a member an admin role only within one organization?
      - Can I assign several roles to an organization member at once?
      instructions:
      - text: Assign roles {roles} to user {user_id} in organization {id}.
        slots:
          roles: requestBody.roles
          user_id: path.user_id
          id: path.id
      - text: Grant member {user_id} the role {roles} within organization {id}.
        slots:
          user_id: path.user_id
          roles: requestBody.roles
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{id}/members/{user_id}/roles'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove roles from an organization member
      effect: destructive
      questions:
      - How do I take an organization-specific role away from a member?
      - Does removing an organization role affect the user's roles in other organizations?
      instructions:
      - text: Remove roles {roles} from user {user_id} in organization {id}.
        slots:
          roles: requestBody.roles
          user_id: path.user_id
          id: path.id
      - text: Revoke the role {roles} from member {user_id} of organization {id}.
        slots:
          roles: requestBody.roles
          user_id: path.user_id
          id: path.id
      method: generated
      generated: '2026-10-01'