Auth0 Node.js SDK - v5.6.0
    Preparing search index...

    Class ManagementClient

    Auth0 Management API client wrapper.

    Provides a high-level interface to Auth0's Management API with automatic token management, telemetry, and Auth0-specific configuration.

    const client = new ManagementClient({
      domain: 'your-tenant.auth0.com',
      clientId: 'your-client-id',
      clientSecret: 'your-client-secret'
    });

    const client = new ManagementClient({
      domain: 'your-tenant.auth0.com',
      clientId: 'your-client-id',
      clientAssertionSigningKey: 'your-private-key'
    });

    const client = new ManagementClient({
      domain: 'your-tenant.auth0.com',
      token: 'your-static-token'  // or () => getAccessToken()
    });

    const client = new ManagementClient({
      domain: 'your-tenant.auth0.com',
      clientId: 'your-client-id',
      clientSecret: 'your-client-secret',
      withCustomDomainHeader: 'auth.example.com'  // Auto-applies to whitelisted endpoints
    });

    const client = new ManagementClient({
      domain: 'your-tenant.auth0.com',
      clientId: 'your-client-id',
      clientSecret: 'your-client-secret',
      withCustomDomainHeader: 'auth.example.com',  // Custom domain header logic
      fetcher: async (args) => {
        console.log('Making request:', args.url);  // Custom logging
        return fetch(args.url, { ...args });       // Custom fetch implementation
      }
    });

    Hierarchy (View Summary)

    Index

    Management API

    constructor

    Accessors

    actions branding clientGrants clients connectionProfiles connections customDomains deviceCredentials emailTemplates eventStreams flows forms userGrants groups hooks jobs logStreams logs networkAcls organizations prompts refreshTokens resourceServers roles rules rulesConfigs selfServiceProfiles sessions stats supplementalSignals tickets tokenExchangeProfiles userAttributeProfiles userBlocks users anomaly attackProtection emails guardian keys riskAssessments tenants verifiableCredentials

    Methods

    fetch

    Properties

    _options _actions _branding _clientGrants _clients _connectionProfiles _connections _customDomains _deviceCredentials _emailTemplates _eventStreams _flows _forms _userGrants _groups _hooks _jobs _logStreams _logs _networkAcls _organizations _prompts _refreshTokens _resourceServers _roles _rules _rulesConfigs _selfServiceProfiles _sessions _stats _supplementalSignals _tickets _tokenExchangeProfiles _userAttributeProfiles _userBlocks _users _anomaly _attackProtection _emails _guardian _keys _riskAssessments _tenants _verifiableCredentials

    Management API

    Accessors

    Methods

    • Make a passthrough request using the SDK's configured auth, retry, logging, etc. This is useful for making requests to endpoints not yet supported in the SDK. The input can be a URL string, URL object, or Request object. Relative paths are resolved against the configured base URL.

      Parameters

      • input: string | Request | URL

        The URL, path, or Request object.

      • Optionalinit: RequestInit

        Standard fetch RequestInit options.

      • OptionalrequestOptions: RequestOptions

        Per-request overrides (timeout, retries, headers, abort signal).

      Returns Promise<Response>

      A standard Response object.

    Properties

    Protected Readonly_options

    _options: NormalizedClientOptionsWithAuth<BaseClientOptions>

    Protected_actions

    _actions: ActionsClient | undefined

    Protected_branding

    _branding: BrandingClient | undefined

    Protected_clientGrants

    _clientGrants: ClientGrantsClient | undefined

    Protected_clients

    _clients: ClientsClient | undefined

    Protected_connectionProfiles

    _connectionProfiles: ConnectionProfilesClient | undefined

    Protected_connections

    _connections: ConnectionsClient | undefined

    Protected_customDomains

    _customDomains: CustomDomainsClient | undefined

    Protected_deviceCredentials

    _deviceCredentials: DeviceCredentialsClient | undefined

    Protected_emailTemplates

    _emailTemplates: EmailTemplatesClient | undefined

    Protected_eventStreams

    _eventStreams: EventStreamsClient | undefined

    Protected_flows

    _flows: FlowsClient | undefined

    Protected_forms

    _forms: FormsClient | undefined

    Protected_userGrants

    _userGrants: UserGrantsClient | undefined

    Protected_groups

    _groups: GroupsClient | undefined

    Protected_hooks

    _hooks: HooksClient | undefined

    Protected_jobs

    _jobs: JobsClient | undefined

    Protected_logStreams

    _logStreams: LogStreamsClient | undefined

    Protected_logs

    _logs: LogsClient | undefined

    Protected_networkAcls

    _networkAcls: NetworkAclsClient | undefined

    Protected_organizations

    _organizations: OrganizationsClient | undefined

    Protected_prompts

    _prompts: PromptsClient | undefined

    Protected_refreshTokens

    _refreshTokens: RefreshTokensClient | undefined

    Protected_resourceServers

    _resourceServers: ResourceServersClient | undefined

    Protected_roles

    _roles: RolesClient | undefined

    Protected_rules

    _rules: RulesClient | undefined

    Protected_rulesConfigs

    _rulesConfigs: RulesConfigsClient | undefined

    Protected_selfServiceProfiles

    _selfServiceProfiles: SelfServiceProfilesClient | undefined

    Protected_sessions

    _sessions: SessionsClient | undefined

    Protected_stats

    _stats: StatsClient | undefined

    Protected_supplementalSignals

    _supplementalSignals: SupplementalSignalsClient | undefined

    Protected_tickets

    _tickets: TicketsClient | undefined

    Protected_tokenExchangeProfiles

    _tokenExchangeProfiles: TokenExchangeProfilesClient | undefined

    Protected_userAttributeProfiles

    _userAttributeProfiles: UserAttributeProfilesClient | undefined

    Protected_userBlocks

    _userBlocks: UserBlocksClient | undefined

    Protected_users

    _users: UsersClient | undefined

    Protected_anomaly

    _anomaly: AnomalyClient | undefined

    Protected_attackProtection

    _attackProtection: AttackProtectionClient | undefined

    Protected_emails

    _emails: EmailsClient | undefined

    Protected_guardian

    _guardian: GuardianClient | undefined

    Protected_keys

    _keys: KeysClient | undefined

    Protected_riskAssessments

    _riskAssessments: RiskAssessmentsClient | undefined

    Protected_tenants

    _tenants: TenantsClient | undefined

    Protected_verifiableCredentials

    _verifiableCredentials: VerifiableCredentialsClient | undefined

    Settings

    Member Visibility

    On This Page

    Management API
    Accessors
    Methods
    Properties