@squidcloud/client
    Preparing search index...

    Class ManagementClient

    Client for programmatic management of Squid organizations and applications.

    Use this client to automate organization and application management using management API keys (created in the Squid Console Profile Settings).

    const client = new ManagementClient({
      apiKey: 'squid_mgmt_xxx...',
      region: 'us-east-1.aws'
    });

    // Create an organization
    const { organizationId } = await client.createOrganization({ name: 'My Org' });

    // Create an application
    const { appId } = await client.createApplication({
      organizationId,
      name: 'My App',
      region: 'us-east-1.aws'
    });

    // Delete an application
    await client.deleteApplication('my-app-id');
    Index

    Constructors

    constructor

    Methods

    createApplication createOrganization deleteApplication renameApplication renameOrganization

    Constructors

    Methods

    • Deletes an application. Requires the user to be an admin in the application's organization.

      Parameters

      • appId: string

        The ID of the application to delete

      Returns Promise<void>

      Error if user is not admin or application not found

    • Renames an application. Requires the user to be an admin in the application's organization.

      Parameters

      Returns Promise<void>

      Error if user is not admin or application not found

    • Renames an organization. Requires the user to be an admin in the organization.

      Parameters

      Returns Promise<void>

      Error if user is not admin or organization not found

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods