Class Clients

Clients API client for the Mosaia SDK

Provides CRUD operations for managing OAuth clients in the Mosaia platform. Clients represent OAuth applications that can authenticate with the Mosaia API, enabling secure access to platform resources through various authentication flows.

This class inherits from BaseCollection and provides the following functionality:

  • Retrieve OAuth clients with filtering and pagination
  • Create new OAuth client applications
  • Update existing client configurations
  • Delete OAuth clients
  • Manage client secrets and redirect URIs
  • Handle OAuth scopes and permissions

Example

import { Mosaia } from 'mosaia-node-sdk';

const mosaia = new Mosaia({ apiKey: 'your-api-key' });
const clients = mosaia.clients;

// Get all OAuth clients
const allClients = await clients.get();

// Get a specific OAuth client
const client = await clients.get({}, 'client-id');

// Create a new OAuth client
const newClient = await clients.create({
  name: 'My Application',
  client_id: 'my-app-client-id',
  client_secret: 'my-app-client-secret',
  redirect_uris: ['https://myapp.com/callback'],
  scopes: ['read', 'write']
});

Hierarchy

Constructors

constructor

Methods

get create update delete

Constructors

constructor

  • new Clients(uri?: string): Clients

    Creates a new Clients API client instance

    Initializes the clients API client with the appropriate endpoint URI and model class for handling OAuth client operations.

    The constructor sets up the API endpoint to /client (or ${uri}/client if a base URI is provided), which corresponds to the Mosaia API's OAuth clients endpoint.

    Parameters

    • uri: string = ''

      Optional base URI path. If provided, the endpoint will be ${uri}/client. If not provided, defaults to /client.

    Returns Clients

    Example

    // Create with default endpoint (/client)
    const clients = new Clients();

    // Create with custom base URI
    const clients = new Clients('/api/v1');
    // This will use endpoint: /api/v1/client

Methods

get

  • get(params: undefined | QueryParams, id: string): Promise<null | Client>

    Get entities with optional filtering and pagination

    This method retrieves entities from the API. When called without an ID, it returns a list of entities with optional filtering and pagination. When called with an ID, it returns a specific entity.

    Parameters

    • params: undefined | QueryParams

      Optional query parameters for filtering and pagination

      • undefined
      • QueryParams

        Query parameters interface for API requests

        Used to define common query parameters that can be passed to API endpoints for filtering, sorting, and pagination.

        • [key: string]: any

          Additional custom query parameters

        • Optionalq?: string

          Search term for text-based filtering

        • Optionallimit?: number

          Maximum number of items to return

        • Optionaloffset?: number

          Number of items to skip (for offset-based pagination)

        • Optionaltags?: string[]

          Array of tags to filter by

        • Optionalactive?: boolean

          Filter by active status

        • Optionalexternal_id?: string

          Filter by external ID

    • id: string

      Optional specific entity ID to retrieve

    Returns Promise<null | Client>

    Promise resolving to: - BatchAPIResponse when getting multiple entities - M when getting a single entity by ID - null when entity is not found

    Example

    Get multiple entities with filtering:

    const result = await collection.get({
      limit: 10,
      offset: 0,
      q: 'search term',
      active: true,
      tags: ['tag1', 'tag2']
    });

    console.log('Items:', result.data);
    console.log('Total:', result.paging?.total);

    Example

    Get single entity by ID:

    const entity = await collection.get({}, 'entity-id');
    if (entity) {
      console.log('Found:', entity.id);
    } else {
      console.log('Entity not found');
    }

    Throws

    When API request fails or response is invalid

  • get(params?: QueryParams): Promise<BatchAPIResponse<Client>>

    Get entities with optional filtering and pagination

    This method retrieves entities from the API. When called without an ID, it returns a list of entities with optional filtering and pagination. When called with an ID, it returns a specific entity.

    Parameters

    • Optionalparams: QueryParams

      Optional query parameters for filtering and pagination

      Query parameters interface for API requests

      Used to define common query parameters that can be passed to API endpoints for filtering, sorting, and pagination.

      • [key: string]: any

        Additional custom query parameters

      • Optionalq?: string

        Search term for text-based filtering

      • Optionallimit?: number

        Maximum number of items to return

      • Optionaloffset?: number

        Number of items to skip (for offset-based pagination)

      • Optionaltags?: string[]

        Array of tags to filter by

      • Optionalactive?: boolean

        Filter by active status

      • Optionalexternal_id?: string

        Filter by external ID

    Returns Promise<BatchAPIResponse<Client>>

    Promise resolving to: - BatchAPIResponse when getting multiple entities - M when getting a single entity by ID - null when entity is not found

    Example

    Get multiple entities with filtering:

    const result = await collection.get({
      limit: 10,
      offset: 0,
      q: 'search term',
      active: true,
      tags: ['tag1', 'tag2']
    });

    console.log('Items:', result.data);
    console.log('Total:', result.paging?.total);

    Example

    Get single entity by ID:

    const entity = await collection.get({}, 'entity-id');
    if (entity) {
      console.log('Found:', entity.id);
    } else {
      console.log('Entity not found');
    }

    Throws

    When API request fails or response is invalid

create

  • create(entity: Omit<ClientInterface, "id">): Promise<Client>

    Create a new entity

    This method creates a new entity in the system. The entity ID will be automatically generated by the server. The method returns a new model instance initialized with the created entity's data.

    Parameters

    • entity: Omit<ClientInterface, "id">

      Entity data for the new entity (without ID)

    Returns Promise<Client>

    Promise resolving to a new model instance

    Example

    Create a new user:

    const newUser = await users.create({
      email: 'user@example.com',
      firstName: 'John',
      lastName: 'Doe',
      active: true
    });

    console.log('Created user:', newUser.id);

    Example

    Create with external ID:

    const newAgent = await agents.create({
      name: 'Customer Support',
      shortDescription: 'AI agent for support',
      external_id: 'agent-123',
      extensors: {
        customField: 'value'
      }
    });

    Throws

    When API request fails or response is invalid

    Throws

    When required fields are missing

update

  • update(
        id: string,
        updates: Partial<ClientInterface>,
        params?: QueryParams,
    ): Promise<Client>

    Update an existing entity

    This method updates an existing entity in the system. Only the fields provided in the update data will be updated.

    Parameters

    • id: string

      The entity ID to update

    • updates: Partial<ClientInterface>

      Partial entity data for the update (only provided fields will be updated)

    • Optionalparams: QueryParams

      Optional query parameters for the request

    Returns Promise<Client>

    Promise resolving to the updated model instance

    Example

    Update user's email:

    const updatedUser = await users.update('user-id', {
      email: 'newemail@example.com'
    });

    Example

    Update multiple fields:

    const updatedAgent = await agents.update('agent-id', {
      name: 'Updated Agent Name',
      shortDescription: 'Updated description',
      active: false
    });

    Throws

    When API request fails or response is invalid

    Throws

    When entity ID is not provided

delete

  • delete(id: string, params?: QueryParams): Promise<void>

    Delete an entity

    This method permanently deletes an entity from the system. This action cannot be undone.

    Parameters

    • id: string

      The entity ID to delete

    • Optionalparams: QueryParams

      Optional query parameters object. Can include:

      • force: Force deletion even if entity has dependencies (boolean)

    Returns Promise<void>

    Promise that resolves when deletion is successful

    Example

    Basic deletion:

    await users.delete('user-id');

    Example

    Force delete:

    await organizations.delete('org-id', { force: true });

    Throws

    When API request fails or entity not found

    Throws

    When entity ID is not provided

Settings

Member Visibility

On This Page

Constructors
Methods