Class SeamHttpAcsUsers

constructor

• new SeamHttpAcsUsers(apiKeyOrOptions?): SeamHttpAcsUsers

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAcsUsers

client

Readonly defaults

addToAccessGroup

• addToAccessGroup(body?): Promise<void>

• Parameters

  • Optional body: {
        acs_access_group_id: string;
        acs_user_id: string;
    }

    • acs_access_group_id: string

    • acs_user_id: string

  Returns Promise<void>

create

• create(body?): Promise<{
      acs_system_id: string;
      acs_user_id: string;
      created_at: string;
      display_name: string;
      email?: string;
      email_address?: string;
      external_type: "pti_user" | "brivo_user";
      external_type_display_name: string;
      full_name?: string;
      is_suspended: boolean;
      phone_number?: string;
      workspace_id: string;
  }>

• Parameters

  • Optional body: {
        acs_access_group_ids?: string[];
        acs_system_id: string;
        email?: string;
        email_address?: string;
        full_name?: string;
        phone_number?: string;
    }

    • Optional acs_access_group_ids?: string[]

    • acs_system_id: string

    • Optional email?: string

      Deprecated: use email_address.

    • Optional email_address?: string

    • Optional full_name?: string

    • Optional phone_number?: string

  Returns Promise<{
      acs_system_id: string;
      acs_user_id: string;
      created_at: string;
      display_name: string;
      email?: string;
      email_address?: string;
      external_type: "pti_user" | "brivo_user";
      external_type_display_name: string;
      full_name?: string;
      is_suspended: boolean;
      phone_number?: string;
      workspace_id: string;
  }>

delete

• delete(body?): Promise<void>

• Parameters

  • Optional body: {
        acs_user_id: string;
    }

    • acs_user_id: string

  Returns Promise<void>

get

• get(body?): Promise<{
      acs_system_id: string;
      acs_user_id: string;
      created_at: string;
      display_name: string;
      email?: string;
      email_address?: string;
      external_type: "pti_user" | "brivo_user";
      external_type_display_name: string;
      full_name?: string;
      is_suspended: boolean;
      phone_number?: string;
      workspace_id: string;
  }>

• Parameters

  • Optional body: {
        acs_user_id: string;
    }

    • acs_user_id: string

  Returns Promise<{
      acs_system_id: string;
      acs_user_id: string;
      created_at: string;
      display_name: string;
      email?: string;
      email_address?: string;
      external_type: "pti_user" | "brivo_user";
      external_type_display_name: string;
      full_name?: string;
      is_suspended: boolean;
      phone_number?: string;
      workspace_id: string;
  }>

list

• list(body?): Promise<{
      acs_system_id: string;
      acs_user_id: string;
      created_at: string;
      display_name: string;
      email?: string;
      email_address?: string;
      external_type: "pti_user" | "brivo_user";
      external_type_display_name: string;
      full_name?: string;
      is_suspended: boolean;
      phone_number?: string;
      workspace_id: string;
  }[]>

• Parameters

  • Optional body: {
        acs_system_id: string;
    }

    • acs_system_id: string

  Returns Promise<{
      acs_system_id: string;
      acs_user_id: string;
      created_at: string;
      display_name: string;
      email?: string;
      email_address?: string;
      external_type: "pti_user" | "brivo_user";
      external_type_display_name: string;
      full_name?: string;
      is_suspended: boolean;
      phone_number?: string;
      workspace_id: string;
  }[]>

removeFromAccessGroup

• removeFromAccessGroup(body?): Promise<void>

• Parameters

  • Optional body: {
        acs_access_group_id: string;
        acs_user_id: string;
    }

    • acs_access_group_id: string

    • acs_user_id: string

  Returns Promise<void>

suspend

• suspend(body?): Promise<void>

• Parameters

  • Optional body: {
        acs_user_id: string;
    }

    • acs_user_id: string

  Returns Promise<void>

unsuspend

• unsuspend(body?): Promise<void>

• Parameters

  • Optional body: {
        acs_user_id: string;
    }

    • acs_user_id: string

  Returns Promise<void>

update

• update(body?): Promise<void>

• Parameters

  • Optional body: {
        acs_user_id: string;
        email?: string;
        email_address?: string;
        full_name?: string;
        phone_number?: string;
    }

    • acs_user_id: string

    • Optional email?: string

      Deprecated: use email_address.

    • Optional email_address?: string

    • Optional full_name?: string

    • Optional phone_number?: string

  Returns Promise<void>

Static fromApiKey

• fromApiKey(apiKey, options?): SeamHttpAcsUsers

• Parameters

  • apiKey: string

  • options: Omit<SeamHttpOptionsWithApiKey, "apiKey"> = {}

  Returns SeamHttpAcsUsers

Static fromClient

• fromClient(client, options?): SeamHttpAcsUsers

• Parameters

  • client: AxiosInstance

  • options: Omit<SeamHttpOptionsWithClient, "client"> = {}

  Returns SeamHttpAcsUsers

Static fromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpAcsUsers

• Parameters

  • clientSessionToken: string

  • options: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken"> = {}

  Returns SeamHttpAcsUsers

Static fromConsoleSessionToken

• fromConsoleSessionToken(consoleSessionToken, workspaceId, options?): SeamHttpAcsUsers

• Parameters

  • consoleSessionToken: string

  • workspaceId: string

  • options: Omit<SeamHttpOptionsWithConsoleSessionToken, "consoleSessionToken" | "workspaceId"> = {}

  Returns SeamHttpAcsUsers

Static fromPersonalAccessToken

• fromPersonalAccessToken(personalAccessToken, workspaceId, options?): SeamHttpAcsUsers

• Parameters

  • personalAccessToken: string

  • workspaceId: string

  • options: Omit<SeamHttpOptionsWithPersonalAccessToken, "workspaceId" | "personalAccessToken"> = {}

  Returns SeamHttpAcsUsers

Static fromPublishableKey

• fromPublishableKey(publishableKey, userIdentifierKey, options?): Promise<SeamHttpAcsUsers>

• Parameters

  • publishableKey: string

  • userIdentifierKey: string

  • options: SeamHttpFromPublishableKeyOptions = {}

  Returns Promise<SeamHttpAcsUsers>