Getting Started

Copy a setup prompt with the install steps and the full markdown guide for this plugin.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-intune`, `@capgo/capacitor-persona`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/persona/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Install

bun add @capgo/capacitor-intune
bunx cap sync

Import

import { IntuneMAM } from '@capgo/capacitor-intune';

API Overview

`acquireToken`

Present the Microsoft sign-in flow and return an access token plus the account metadata.

import { IntuneMAM } from '@capgo/capacitor-intune';

await IntuneMAM.acquireToken({} as AcquireTokenOptions);

`acquireTokenSilent`

Acquire a token from the MSAL cache for a previously signed-in user.

import { IntuneMAM } from '@capgo/capacitor-intune';

await IntuneMAM.acquireTokenSilent({} as AcquireTokenSilentOptions);

`registerAndEnrollAccount`

import { IntuneMAM } from '@capgo/capacitor-intune';

await IntuneMAM.registerAndEnrollAccount({} as RegisterAndEnrollAccountOptions);

`loginAndEnrollAccount`

Ask Intune to authenticate and enroll a user without first requesting an app token.

import { IntuneMAM } from '@capgo/capacitor-intune';

await IntuneMAM.loginAndEnrollAccount();

`enrolledAccount`

Return the currently enrolled Intune account, if one is available.

import { IntuneMAM } from '@capgo/capacitor-intune';

await IntuneMAM.enrolledAccount();

`deRegisterAndUnenrollAccount`

Deregister the account from Intune and trigger selective wipe when applicable.

import { IntuneMAM } from '@capgo/capacitor-intune';

await IntuneMAM.deRegisterAndUnenrollAccount({} as IntuneMAMUser);

`logoutOfAccount`

Sign the user out of MSAL without unenrolling the Intune account.

import { IntuneMAM } from '@capgo/capacitor-intune';

await IntuneMAM.logoutOfAccount({} as IntuneMAMUser);

`appConfig`

Fetch the remote Intune app configuration for a managed account.

import { IntuneMAM } from '@capgo/capacitor-intune';

await IntuneMAM.appConfig({} as IntuneMAMUser);

`getPolicy`

Fetch the currently effective Intune app protection policy for a managed account.

import { IntuneMAM } from '@capgo/capacitor-intune';

await IntuneMAM.getPolicy({} as IntuneMAMUser);

`groupName`

Convenience helper that resolves the GroupName app configuration value when present.

import { IntuneMAM } from '@capgo/capacitor-intune';

await IntuneMAM.groupName({} as IntuneMAMUser);

`sdkVersion`

Return the native Intune and MSAL SDK versions bundled by this plugin.

import { IntuneMAM } from '@capgo/capacitor-intune';

await IntuneMAM.sdkVersion();

`displayDiagnosticConsole`

Show the native Intune diagnostics UI.

import { IntuneMAM } from '@capgo/capacitor-intune';

await IntuneMAM.displayDiagnosticConsole();

Type Reference

`AcquireTokenOptions`

Interactive token acquisition options.

export interface AcquireTokenOptions {
  /**
   * Scopes to request, for example `https://graph.microsoft.com/.default`.
   */
  scopes: string[];

  /**
   * When true, always show the Microsoft account picker or sign-in UI.
   *
   * @default false
   */
  forcePrompt?: boolean;

  /**
   * Optional login hint for the interactive sign-in flow.
   */
  loginHint?: string;
}

`IntuneMAMAcquireToken`

export interface IntuneMAMAcquireToken {
  accountId: string;
  accessToken: string;
  accountIdentifier: string;
  idToken?: string;
  username?: string;
  tenantId?: string;
  authority?: string;
}

`AcquireTokenSilentOptions`

Silent token acquisition options.

export interface AcquireTokenSilentOptions {
  /**
   * Scopes to request, for example `https://graph.microsoft.com/.default`.
   */
  scopes: string[];

  /**
   * Microsoft Entra object ID returned by `acquireToken` or `enrolledAccount`.
   */
  accountId: string;

  /**
   * When true, bypass the cached access token and request a fresh one.
   *
   * @default false
   */
  forceRefresh?: boolean;
}

`RegisterAndEnrollAccountOptions`

export interface RegisterAndEnrollAccountOptions {
  /**
   * Microsoft Entra object ID returned by `acquireToken`.
   */
  accountId: string;
}

`IntuneMAMUser`

export interface IntuneMAMUser {
  accountId: string;
  accountIdentifier?: string;
  username?: string;
  tenantId?: string;
  authority?: string;
}

`IntuneMAMAppConfig`

export interface IntuneMAMAppConfig {
  accountId: string;
  fullData: Record<string, string>[];
  values: Record<string, string>;
  conflicts: string[];
}

`IntuneMAMPolicy`

export interface IntuneMAMPolicy {
  accountId: string;
  isPinRequired?: boolean;
  isManagedBrowserRequired?: boolean;
  isScreenCaptureAllowed?: boolean;
  isContactSyncAllowed?: boolean;
  isAppSharingAllowed?: boolean;
  isFileEncryptionRequired?: boolean;
  notificationPolicy?: string;
}

`IntuneMAMGroupName`

export interface IntuneMAMGroupName {
  accountId: string;
  groupName?: string;
}

`IntuneMAMVersionInfo`

export interface IntuneMAMVersionInfo {
  platform: 'ios' | 'android';
  intuneSdkVersion: string;
  msalVersion?: string;
}

`IntuneMAMChangeEvent`

export interface IntuneMAMChangeEvent {
  accountId?: string;
}

Source Of Truth

This page is generated from the plugin’s src/definitions.ts. Re-run the sync when the public API changes upstream.