다음을 통해 공유

InteractiveBrowserCredentialNodeOptions interface

  • 참조
패키지:
@azure/identity

InteractiveBrowserCredential 클래스에 대한 일반적인 옵션을 정의합니다.

Extends

InteractiveCredentialOptions,CredentialPersistenceOptions,BrowserCustomizationOptions,BrokerAuthOptions

속성

clientId

테넌트에서 앱 등록의 클라이언트(애플리케이션) ID입니다.
loginHint

loginHint를 사용하면 대화형 로그인에 대해 사용자 이름을 미리 선택할 수 있습니다. 이 옵션을 설정하면 계정 선택 프롬프트가 건너뛰고 지정된 계정으로 즉시 로그인을 시도합니다.
redirectUri

애플리케이션의 리디렉션 URI를 가져옵니다. 애플리케이션 등록 포털의 값과 동일해야 합니다. 기본값은 window.location.href입니다. 이 필드는 더 이상 Node.js 필요하지 않습니다.
tenantId

Microsoft Entra 테넌트(디렉터리) ID입니다.

상속된 속성

additionallyAllowedTenants

다중 테넌트 애플리케이션의 경우 자격 증명이 토큰을 획득할 수 있는 추가 테넌트 를 지정합니다. 자격 증명이 애플리케이션이 설치된 테넌트의 토큰을 획득할 수 있도록 와일드카드 값 "*"을 추가합니다.
additionalPolicies

HTTP 파이프라인에 포함할 추가 정책입니다.
allowInsecureConnection

요청이 HTTPS 대신 HTTP를 통해 전송되는 경우 true로 설정
authenticationRecord

각 개별 계정의 캐시된 자격 증명을 검색하는 데 사용할 수 있는 이전 인증의 결과입니다. 애플리케이션이 클라이언트 ID 및 테넌트 ID 쌍당 둘 이상의 계정으로 작업하려는 경우 이를 제공해야 합니다.

이 레코드는 다음과 같이 자격 증명의 authenticate() 메서드를 호출하여 검색할 수 있습니다.

const authenticationRecord = await credential.authenticate();
authorityHost

인증 요청에 사용할 기관 호스트입니다. 가능한 값은 AzureAuthorityHosts를 통해 사용할 수 있습니다. 기본값은 “https://login.microsoftonline.com"”입니다.
brokerOptions

InteractiveBrowserCredential을 사용할 때 브로커 인증을 허용하는 옵션
browserCustomizationOptions

브라우저 사용자 지정을 위한 공유 구성 옵션
disableAutomaticAuthentication

수동 인증이 필요한 경우 getToken을 throw합니다. 개발자는 를 호출 authenticate() 하여 수동으로 인증해야 하는 시기를 제어해야 합니다.
disableInstanceDiscovery

필드는 인증을 시도할 때 instance 검색이 수행되는지 여부를 결정합니다. 이를 로 true 설정하면 instance 검색 및 권한 유효성 검사가 모두 완전히 비활성화됩니다. 따라서 구성된 기관 호스트가 유효하고 신뢰할 수 있는지 확인하는 것이 중요합니다. 이 기능은 프라이빗 클라우드 또는 Azure Stack과 같이 메타데이터 엔드포인트에 연결할 수 없는 시나리오에서 사용하기 위한 것입니다. instance 검색 프로세스에는 인증 기관의 유효성을 검사하기 위해 에서 https://login.microsoft.com/ 기관 메타데이터를 검색해야 합니다.
httpClient

HTTP 요청을 보내는 데 사용할 HttpClient입니다.
loggingOptions

사용자가 로깅 정책 옵션에 대한 설정을 구성하고, 고객 지원을 위해 계정 정보 로깅 및 개인 식별 정보를 허용할 수 있습니다.
proxyOptions

나가는 요청에 대한 프록시를 구성하는 옵션입니다.
redirectOptions

리디렉션 응답을 처리하는 방법에 대한 옵션입니다.
retryOptions

실패한 요청을 다시 시도하는 방법을 제어하는 옵션입니다.
telemetryOptions

일반적인 원격 분석 및 추적 정보를 나가는 요청으로 설정하는 옵션입니다.
tlsOptions

TLS 인증을 구성하기 위한 옵션
tokenCachePersistenceOptions

자격 증명을 저장할 때 지속성 계층에 제공하는 옵션(사용 가능한 경우)입니다.

먼저 지속성 공급자 플러그 인을 등록해야 합니다. NPM에서 @azure/identity-cache-persistence 패키지를 참조하세요.

예제:

import { cachePersistencePlugin } from "@azure/identity-cache-persistence";
import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";

useIdentityPlugin(cachePersistencePlugin);

async function main() {
  const credential = new DeviceCodeCredential({
    tokenCachePersistenceOptions: {
      enabled: true
    }
  });
}

main().catch((error) => {
  console.error("An error occurred:", error);
  process.exit(1);
});
userAgentOptions

나가는 요청에 사용자 에이전트 세부 정보를 추가하는 옵션입니다.

속성 세부 정보

clientId

테넌트에서 앱 등록의 클라이언트(애플리케이션) ID입니다.

clientId?: string

속성 값

string

loginHint

loginHint를 사용하면 대화형 로그인에 대해 사용자 이름을 미리 선택할 수 있습니다. 이 옵션을 설정하면 계정 선택 프롬프트가 건너뛰고 지정된 계정으로 즉시 로그인을 시도합니다.

loginHint?: string

속성 값

string

redirectUri

애플리케이션의 리디렉션 URI를 가져옵니다. 애플리케이션 등록 포털의 값과 동일해야 합니다. 기본값은 window.location.href입니다. 이 필드는 더 이상 Node.js 필요하지 않습니다.

redirectUri?: string | () => string

속성 값

string | () => string

tenantId

Microsoft Entra 테넌트(디렉터리) ID입니다.

tenantId?: string

속성 값

string

상속된 속성 세부 정보

additionallyAllowedTenants

다중 테넌트 애플리케이션의 경우 자격 증명이 토큰을 획득할 수 있는 추가 테넌트 를 지정합니다. 자격 증명이 애플리케이션이 설치된 테넌트의 토큰을 획득할 수 있도록 와일드카드 값 "*"을 추가합니다.

additionallyAllowedTenants?: string[]

속성 값

string[]

InteractiveCredentialOptions.additionallyAllowedTenants에서 상속됨

additionalPolicies

HTTP 파이프라인에 포함할 추가 정책입니다.

additionalPolicies?: AdditionalPolicyConfig[]

속성 값

AdditionalPolicyConfig[]

InteractiveCredentialOptions.additionalPolicies에서 상속됨

allowInsecureConnection

요청이 HTTPS 대신 HTTP를 통해 전송되는 경우 true로 설정

allowInsecureConnection?: boolean

속성 값

boolean

InteractiveCredentialOptions.allowInsecureConnection에서 상속됨

authenticationRecord

각 개별 계정의 캐시된 자격 증명을 검색하는 데 사용할 수 있는 이전 인증의 결과입니다. 애플리케이션이 클라이언트 ID 및 테넌트 ID 쌍당 둘 이상의 계정으로 작업하려는 경우 이를 제공해야 합니다.

이 레코드는 다음과 같이 자격 증명의 authenticate() 메서드를 호출하여 검색할 수 있습니다.

const authenticationRecord = await credential.authenticate();

authenticationRecord?: AuthenticationRecord

속성 값

AuthenticationRecord

InteractiveCredentialOptions.authenticationRecord에서 상속됨

authorityHost

인증 요청에 사용할 기관 호스트입니다. 가능한 값은 AzureAuthorityHosts를 통해 사용할 수 있습니다. 기본값은 “https://login.microsoftonline.com"”입니다.

authorityHost?: string

속성 값

string

InteractiveCredentialOptions.authorityHost에서 상속됨

brokerOptions

InteractiveBrowserCredential을 사용할 때 브로커 인증을 허용하는 옵션

brokerOptions?: BrokerOptions

속성 값

BrokerOptions

BrokerAuthOptions.brokerOptions에서 상속됨

browserCustomizationOptions

브라우저 사용자 지정을 위한 공유 구성 옵션

browserCustomizationOptions?: { errorMessage?: string, successMessage?: string }

속성 값

{ errorMessage?: string, successMessage?: string }

BrowserCustomizationOptions.browserCustomizationOptions에서 상속됨

disableAutomaticAuthentication

수동 인증이 필요한 경우 getToken을 throw합니다. 개발자는 를 호출 authenticate() 하여 수동으로 인증해야 하는 시기를 제어해야 합니다.

disableAutomaticAuthentication?: boolean

속성 값

boolean

InteractiveCredentialOptions.disableAutomaticAuthentication에서 상속됨

disableInstanceDiscovery

필드는 인증을 시도할 때 instance 검색이 수행되는지 여부를 결정합니다. 이를 로 true 설정하면 instance 검색 및 권한 유효성 검사가 모두 완전히 비활성화됩니다. 따라서 구성된 기관 호스트가 유효하고 신뢰할 수 있는지 확인하는 것이 중요합니다. 이 기능은 프라이빗 클라우드 또는 Azure Stack과 같이 메타데이터 엔드포인트에 연결할 수 없는 시나리오에서 사용하기 위한 것입니다. instance 검색 프로세스에는 인증 기관의 유효성을 검사하기 위해 에서 https://login.microsoft.com/ 기관 메타데이터를 검색해야 합니다.

disableInstanceDiscovery?: boolean

속성 값

boolean

InteractiveCredentialOptions.disableInstanceDiscovery에서 상속됨

httpClient

HTTP 요청을 보내는 데 사용할 HttpClient입니다.

httpClient?: HttpClient

속성 값

HttpClient

InteractiveCredentialOptions.httpClient에서 상속됨

loggingOptions

사용자가 로깅 정책 옵션에 대한 설정을 구성하고, 고객 지원을 위해 계정 정보 로깅 및 개인 식별 정보를 허용할 수 있습니다.

loggingOptions?: LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }

속성 값

LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }

InteractiveCredentialOptions.loggingOptions에서 상속됨

proxyOptions

나가는 요청에 대한 프록시를 구성하는 옵션입니다.

proxyOptions?: ProxySettings

속성 값

ProxySettings

InteractiveCredentialOptions.proxyOptions에서 상속됨

redirectOptions

리디렉션 응답을 처리하는 방법에 대한 옵션입니다.

redirectOptions?: RedirectPolicyOptions

속성 값

RedirectPolicyOptions

InteractiveCredentialOptions.redirectOptions에서 상속됨

retryOptions

실패한 요청을 다시 시도하는 방법을 제어하는 옵션입니다.

retryOptions?: PipelineRetryOptions

속성 값

PipelineRetryOptions

InteractiveCredentialOptions.retryOptions에서 상속됨

telemetryOptions

일반적인 원격 분석 및 추적 정보를 나가는 요청으로 설정하는 옵션입니다.

telemetryOptions?: TelemetryOptions

속성 값

TelemetryOptions

InteractiveCredentialOptions.telemetryOptions에서 상속됨

tlsOptions

TLS 인증을 구성하기 위한 옵션

tlsOptions?: TlsSettings

속성 값

TlsSettings

InteractiveCredentialOptions.tlsOptions에서 상속됨

tokenCachePersistenceOptions

자격 증명을 저장할 때 지속성 계층에 제공하는 옵션(사용 가능한 경우)입니다.

먼저 지속성 공급자 플러그 인을 등록해야 합니다. NPM에서 @azure/identity-cache-persistence 패키지를 참조하세요.

예제:

import { cachePersistencePlugin } from "@azure/identity-cache-persistence";
import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";

useIdentityPlugin(cachePersistencePlugin);

async function main() {
  const credential = new DeviceCodeCredential({
    tokenCachePersistenceOptions: {
      enabled: true
    }
  });
}

main().catch((error) => {
  console.error("An error occurred:", error);
  process.exit(1);
});

tokenCachePersistenceOptions?: TokenCachePersistenceOptions

속성 값

TokenCachePersistenceOptions

CredentialPersistenceOptions.tokenCachePersistenceOptions에서 상속됨

userAgentOptions

나가는 요청에 사용자 에이전트 세부 정보를 추가하는 옵션입니다.

userAgentOptions?: UserAgentPolicyOptions

속성 값

UserAgentPolicyOptions

InteractiveCredentialOptions.userAgentOptions에서 상속됨