Skip to main content
Docs

deleteScope()

Deletes a machine scope, removing access between two machines.

function deleteScope(machineId: string, otherMachineId: string): Promise<MachineScope>

Parameters

  • Name
    machineId
    Type
    string
    Description

    The ID of the machine that currently has access to the target machine.

  • Name
    otherMachineId
    Type
    string
    Description

    The ID of the machine that will no longer be accessible by the source machine.

Example

Note

Importing clerkClient varies based on your framework. Refer to the Backend SDK overview for usage details, including guidance on how to access the userId and other properties.

const machineId = 'mch_123'
const otherMachineId = 'mch_456'

const response = await clerkClient.machines.deleteScope(machineId, otherMachineId)

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint DELETE/machines/{machine_id}/scopes/{other_machine_id}. See the BAPI reference for more information.

Feedback

What did you think of this content?
Edit this page on GitHub

Last updated on