DeviceTokenCredentials class

Pacote:

@azure/ms-rest-nodeauth

Extends

TokenCredentialsBase

Construtores

DeviceTokenCredentials(string, string, string, TokenAudience, Environment, TokenCache)

Cria um novo objeto DeviceTokenCredentials que obtém um novo token de acesso usando userCodeInfo (contém user_code, device_code) para autenticar o usuário no dispositivo. Quando essa credencial é usada, o script fornecerá uma url e um código. O usuário precisa copiar a url e o código, colá-lo em um navegador e autenticar lá. Se for bem-sucedido, o script receberá o token de acesso.

Propriedades

username

Propriedades Herdadas

authContext
clientId
domain
environment
tokenAudience
tokenCache

Métodos

getToken()

Tenta obter o token do cache inicialmente. Se isso não for bem-sucedido, ele tenta obter o token da ADAL.

Métodos Herdados

setDomain(string)
signRequest(WebResource)	Assina uma solicitação com o cabeçalho Autenticação.

Detalhes do Construtor

DeviceTokenCredentials(string, string, string, TokenAudience, Environment, TokenCache)

Cria um novo objeto DeviceTokenCredentials que obtém um novo token de acesso usando userCodeInfo (contém user_code, device_code) para autenticar o usuário no dispositivo.

Quando essa credencial é usada, o script fornecerá uma url e um código. O usuário precisa copiar a url e o código, colá-lo em um navegador e autenticar lá. Se for bem-sucedido, o script receberá o token de acesso.

new DeviceTokenCredentials(clientId?: string, domain?: string, username?: string, tokenAudience?: TokenAudience, environment?: Environment, tokenCache?: TokenCache)

Parâmetros

clientId

string

A ID do cliente do aplicativo Ative Directory.

domain

string

O domínio ou ID de locatário que contém este aplicativo. O valor padrão é "common"

username

string

O nome de usuário da conta no formato: "user@example.com".

tokenAudience

TokenAudience

O público para o qual o token é solicitado. Os valores válidos são 'gráfico', 'lote' ou qualquer outro recurso como 'https://vault.azure.net/'. Se tokenAudience é 'gráfico', então o domínio também deve ser fornecido e seu valor não deve ser o locatário 'comum' padrão. Deve ser uma string (de preferência em um formato guid). Consulte Ative Directory Quickstart for .Net para obter um exemplo.

environment

Environment

O ambiente azure com o qual autenticar. O ambiente padrão é "Azure", popularmente conhecido como "Public Azure Cloud".

tokenCache

TokenCache

O cache de token. O valor padrão é o objeto MemoryCache de adal.

Detalhes de Propriedade

username

username: string

Valor de Propriedade

string

Detalhes da Propriedade Herdada

authContext

authContext: AuthenticationContext

Valor de Propriedade

AuthenticationContext

herdado de TokenCredentialsBase.authContext

clientId

clientId: string

Valor de Propriedade

string

herdado de TokenCredentialsBase.clientId

domain

domain: string

Valor de Propriedade

string

herdado de TokenCredentialsBase.domain

environment

environment: Environment

Valor de Propriedade

Environment

herdado de TokenCredentialsBase.environment

tokenAudience

tokenAudience?: string

Valor de Propriedade

string

herdado de TokenCredentialsBase.tokenAudience

tokenCache

tokenCache: TokenCache

Valor de Propriedade

TokenCache

herdado de TokenCredentialsBase.tokenCache

Detalhes de Método

getToken()

Tenta obter o token do cache inicialmente. Se isso não for bem-sucedido, ele tenta obter o token da ADAL.

function getToken(): Promise<TokenResponse>

Devoluções

Promise<TokenResponse>

O tokenResponse (tokenType e accessToken são as duas propriedades importantes).

Detalhes do Método Herdado

setDomain(string)

function setDomain(domain: string)

Parâmetros

domain

string

herdado de TokenCredentialsBase.setDomain

signRequest(WebResource)

Assina uma solicitação com o cabeçalho Autenticação.

function signRequest(webResource: WebResource): Promise<WebResource>

Parâmetros

webResource

WebResource

O WebResource a ser assinado.

Devoluções

Promise<WebResource>

herdado de TokenCredentialsBase.signRequest