OnBehalfOfCredential class
Permite que a autenticação Microsoft Entra ID através do fluxo Em Nome de.
Construtores
On |
Cria uma instância do OnBehalfOfCredential com os detalhes necessários para se autenticar em Microsoft Entra ID com caminho para um certificado PEM e uma asserção de utilizador. Exemplo com o
|
On |
Cria uma instância do OnBehalfOfCredential com os detalhes necessários para se autenticar em Microsoft Entra ID com um segredo de cliente e uma afirmação de utilizador. Exemplo com o
|
Métodos
get |
Autentica com Microsoft Entra ID e devolve um token de acesso se for bem-sucedido. Se a autenticação falhar, será emitido um CredentialUnavailableError com os detalhes da falha. |
Detalhes do Construtor
OnBehalfOfCredential(OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)
Cria uma instância do OnBehalfOfCredential com os detalhes necessários para se autenticar em Microsoft Entra ID com caminho para um certificado PEM e uma asserção de utilizador.
Exemplo com o KeyClient
de @azure/keyvault-keys:
const tokenCredential = new OnBehalfOfCredential({
tenantId,
clientId,
certificatePath: "/path/to/certificate.pem",
userAssertionToken: "access-token"
});
const client = new KeyClient("vault-url", tokenCredential);
await client.getKey("key-name");
new OnBehalfOfCredential(options: OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)
Parâmetros
- options
-
OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions
Parâmetros opcionais, geralmente comuns entre credenciais.
OnBehalfOfCredential(OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)
Cria uma instância do OnBehalfOfCredential com os detalhes necessários para se autenticar em Microsoft Entra ID com um segredo de cliente e uma afirmação de utilizador.
Exemplo com o KeyClient
de @azure/keyvault-keys:
const tokenCredential = new OnBehalfOfCredential({
tenantId,
clientId,
clientSecret,
userAssertionToken: "access-token"
});
const client = new KeyClient("vault-url", tokenCredential);
await client.getKey("key-name");
new OnBehalfOfCredential(options: OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)
Parâmetros
- options
-
OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions
Parâmetros opcionais, geralmente comuns entre credenciais.
Detalhes de Método
getToken(string | string[], GetTokenOptions)
Autentica com Microsoft Entra ID e devolve um token de acesso se for bem-sucedido. Se a autenticação falhar, será emitido um CredentialUnavailableError com os detalhes da falha.
function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>
Parâmetros
- scopes
-
string | string[]
A lista de âmbitos aos quais o token terá acesso.
- options
- GetTokenOptions
As opções utilizadas para configurar os pedidos de rede subjacentes.
Devoluções
Promise<AccessToken>