Clerk Frontend Api — Members

naftiko: 1.0.0-alpha2
info:
  label: Clerk Frontend Api — Members
  description: 'Clerk Members capability. 4 operations. Lead operation: Create Organization Membership.'
  tags:
  - Clerk
  - Members
  created: '2026-05-22'
  modified: '2026-05-22'
binds:
- namespace: env
  keys:
    CLERK_PUBLISHABLE_KEY: CLERK_PUBLISHABLE_KEY
capability:
  consumes:
  - type: http
    namespace: clerk-frontend-api-members
    baseUri: ''
    description: Clerk clerk-frontend-api Members business capability.
    resources:
    - name: v1-organizations-organization-id-memberships
      path: /v1/organizations/{organization_id}/memberships
      operations:
      - name: CreateOrganizationMembership
        method: POST
        description: Create Organization Membership
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organization_id
          in: path
          type: string
          description: The organization ID.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: ListOrganizationMemberships
        method: GET
        description: Get All Organization Members
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organization_id
          in: path
          type: string
          description: The organization ID.
          required: true
        - name: query
          in: query
          type: string
          description: 'Returns members that match the given query.

            For possible matches, we check for any of the user''s identifier, usernames, user IDs, first and last names.

            The query value doesn''t need to match the exact '
          required: false
        - name: role
          in: query
          type: string
          description: Filter by roles. This can be one of the predefined roles (`org:admin`, `org:basic_member`) or a custom role defined.
          required: false
    - name: v1-organizations-organization-id-memberships-user-id
      path: /v1/organizations/{organization_id}/memberships/{user_id}
      operations:
      - name: UpdateOrganizationMembership
        method: PATCH
        description: Update Organization Membership
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organization_id
          in: path
          type: string
          description: The organization ID.
          required: true
        - name: user_id
          in: path
          type: string
          description: The member ID.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: removeOrganizationMember
        method: DELETE
        description: Remove Organization Member
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organization_id
          in: path
          type: string
          description: The organization ID.
          required: true
        - name: user_id
          in: path
          type: string
          description: The member ID.
          required: true