Clerk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clerk Backend Organization Memberships API

7 actions 7 updates phrasing extends openapi/clerk-com-organization-memberships-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Clerk's API. It is a proposal applied on top of the contract, not a document Clerk publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/organizations/{organization_id}/memberships'].get
$.paths['/organizations/{organization_id}/memberships'].post
$.paths['/organizations/{organization_id}/memberships/{user_id}'].delete
$.paths['/organizations/{organization_id}/memberships/{user_id}'].patch
$.paths['/organizations/{organization_id}/memberships/{user_id}/metadata'].patch
$.paths['/organization_memberships'].get

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 Clerk Backend Organization Memberships API
  version: 1.0.0
extends: openapi/clerk-com-organization-memberships-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: 6
- target: $.paths['/organizations/{organization_id}/memberships'].get
  update:
    x-apievangelist-phrasing:
      intent: List members of an organization
      effect: read
      questions:
      - Who are the members of a given organization?
      - Can I filter an organization's members by role or by when they were last active?
      instructions:
      - text: List members of organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: List members of organization {organization_id} with role {role}.
        slots:
          organization_id: path.organization_id
          role: query.role
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/memberships'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a user to an organization
      effect: write
      questions:
      - How do I add an existing user to an organization with a role?
      - Can I attach private metadata to a new organization membership?
      instructions:
      - text: Add user {user_id} to organization {organization_id} as {role}.
        slots:
          user_id: requestBody.user_id
          organization_id: path.organization_id
          role: requestBody.role
      - text: Make user {user_id} a {role} of organization {organization_id} with private metadata {private_metadata}.
        slots:
          user_id: requestBody.user_id
          role: requestBody.role
          organization_id: path.organization_id
          private_metadata: requestBody.private_metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/memberships/{user_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a member from an organization
      effect: destructive
      questions:
      - How do I kick a user out of an organization?
      - Can I remove someone from an organization without deleting their user account?
      instructions:
      - text: Remove user {user_id} from organization {organization_id}.
        slots:
          user_id: path.user_id
          organization_id: path.organization_id
      - text: Take user {user_id} out of organization {organization_id}.
        slots:
          user_id: path.user_id
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/memberships/{user_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a member's organization role
      effect: write
      questions:
      - How do I promote an organization member to admin?
      - Can I change a member's role in an organization?
      instructions:
      - text: Change user {user_id}'s role in organization {organization_id} to {role}.
        slots:
          user_id: path.user_id
          organization_id: path.organization_id
          role: requestBody.role
      - text: Promote member {user_id} of organization {organization_id} to {role}.
        slots:
          user_id: path.user_id
          organization_id: path.organization_id
          role: requestBody.role
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/memberships/{user_id}/metadata'].patch
  update:
    x-apievangelist-phrasing:
      intent: Merge metadata on an organization membership
      effect: write
      questions:
      - How do I store custom data on a user's membership in an organization?
      - Is membership metadata deep-merged, and how do I remove a key?
      instructions:
      - text: Merge public metadata {public_metadata} into user {user_id}'s membership in organization {organization_id}.
        slots:
          public_metadata: requestBody.public_metadata
          user_id: path.user_id
          organization_id: path.organization_id
      - text: Deep-merge private metadata {private_metadata} into membership of {user_id} in {organization_id}.
        slots:
          private_metadata: requestBody.private_metadata
          user_id: path.user_id
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organization_memberships'].get
  update:
    x-apievangelist-phrasing:
      intent: List all organization memberships in the instance
      effect: read
      questions:
      - How do I see every organization membership across my whole instance?
      - Can I sort all memberships instance-wide?
      instructions:
      - text: List all organization memberships across the instance.
      - text: List instance-wide memberships ordered by {order_by}.
        slots:
          order_by: query.order_by
      method: generated
      generated: '2026-09-26'