다음을 통해 공유

DeviceCodeCredential class

  • 참조
패키지:
@azure/identity

사용자가 https://microsoft.com/devicelogin입력할 수 있는 디바이스 코드를 사용하여 Microsoft Entra ID에 대한 인증을 사용하도록 설정합니다.

생성자

DeviceCodeCredential(DeviceCodeCredentialOptions)

Microsoft Entra ID를 사용하여 디바이스 코드 권한 부여 흐름을 시작하는 데 필요한 세부 정보를 사용하여 DeviceCodeCredential 인스턴스를 만듭니다.

메시지가 기록되어 사용자가 https://microsoft.com/devicelogin 이동한 후 인증하는 데 사용할 수 있는 코드를 제공합니다.

개발자는 사용자 지정 userPromptCallback전달하여 이 메시지가 표시되는 방식을 구성할 수 있습니다.

import { DeviceCodeCredential } from "@azure/identity";

const credential = new DeviceCodeCredential({
  tenantId: process.env.AZURE_TENANT_ID,
  clientId: process.env.AZURE_CLIENT_ID,
  userPromptCallback: (info) => {
    console.log("CUSTOMIZED PROMPT CALLBACK", info.message);
  },
});

메서드

authenticate(string | string[], GetTokenOptions)

Microsoft Entra ID를 사용하여 인증하고 성공하면 액세스 토큰을 반환합니다. 인증에 실패하면 CredentialUnavailableError 오류 세부 정보와 함께 throw됩니다.

토큰을 자동으로 검색할 수 없는 경우 이 메서드는 항상 사용자에게 챌린지를 생성합니다.
getToken(string | string[], GetTokenOptions)

Microsoft Entra ID를 사용하여 인증하고 성공하면 액세스 토큰을 반환합니다. 인증에 실패하면 CredentialUnavailableError 오류 세부 정보와 함께 throw됩니다.

사용자가 disableAutomaticAuthentication옵션을 제공한 경우 토큰을 자동으로 검색할 수 없으면 이 메서드는 사용자 상호 작용을 요청하여 토큰을 검색하려고 시도하지 않습니다.

생성자 세부 정보

DeviceCodeCredential(DeviceCodeCredentialOptions)

Microsoft Entra ID를 사용하여 디바이스 코드 권한 부여 흐름을 시작하는 데 필요한 세부 정보를 사용하여 DeviceCodeCredential 인스턴스를 만듭니다.

메시지가 기록되어 사용자가 https://microsoft.com/devicelogin 이동한 후 인증하는 데 사용할 수 있는 코드를 제공합니다.

개발자는 사용자 지정 userPromptCallback전달하여 이 메시지가 표시되는 방식을 구성할 수 있습니다.

import { DeviceCodeCredential } from "@azure/identity";

const credential = new DeviceCodeCredential({
  tenantId: process.env.AZURE_TENANT_ID,
  clientId: process.env.AZURE_CLIENT_ID,
  userPromptCallback: (info) => {
    console.log("CUSTOMIZED PROMPT CALLBACK", info.message);
  },
});

new DeviceCodeCredential(options?: DeviceCodeCredentialOptions)

매개 변수

options
DeviceCodeCredentialOptions

인증 요청을 만드는 클라이언트를 구성하는 옵션입니다.

메서드 세부 정보

authenticate(string | string[], GetTokenOptions)

Microsoft Entra ID를 사용하여 인증하고 성공하면 액세스 토큰을 반환합니다. 인증에 실패하면 CredentialUnavailableError 오류 세부 정보와 함께 throw됩니다.

토큰을 자동으로 검색할 수 없는 경우 이 메서드는 항상 사용자에게 챌린지를 생성합니다.

function authenticate(scopes: string | string[], options?: GetTokenOptions): Promise<undefined | AuthenticationRecord>

매개 변수

scopes

string | string[]

토큰에 액세스할 수 있는 범위 목록입니다.

options
GetTokenOptions

이 TokenCredential 구현에서 수행할 수 있는 요청을 구성하는 데 사용되는 옵션입니다.

반환

Promise<undefined | AuthenticationRecord>

getToken(string | string[], GetTokenOptions)

Microsoft Entra ID를 사용하여 인증하고 성공하면 액세스 토큰을 반환합니다. 인증에 실패하면 CredentialUnavailableError 오류 세부 정보와 함께 throw됩니다.

사용자가 disableAutomaticAuthentication옵션을 제공한 경우 토큰을 자동으로 검색할 수 없으면 이 메서드는 사용자 상호 작용을 요청하여 토큰을 검색하려고 시도하지 않습니다.

function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>

매개 변수

scopes

string | string[]

토큰에 액세스할 수 있는 범위 목록입니다.

options
GetTokenOptions

이 TokenCredential 구현에서 수행할 수 있는 요청을 구성하는 데 사용되는 옵션입니다.

반환

Promise<AccessToken>