AuthenticationContext Classe

Recupera tokens de autenticação do Azure Active Directory.

Para usos, marcar a pasta "sample" em:https://github.com/AzureAD/azure-activedirectory-library-for-python

Cria um novo objeto AuthenticationContext.

Por padrão, a autoridade será verificada em relação a uma lista de autoridades conhecidas do Azure Active Directory. Se a autoridade não for reconhecida como uma dessas autoridades conhecidas, a aquisição de tokens falhará. Esse comportamento pode ser desativado por meio do parâmetro validate_authority abaixo.

Herança

builtins.object

AuthenticationContext

Construtor

AuthenticationContext(authority, validate_authority=None, cache=None, api_version=None, timeout=None, enable_pii=False, verify_ssl=None, proxies=None)

Parâmetros

authority

str

Obrigatório

Uma URL que identifica uma autoridade de token. Deve ser do formato https://login.microsoftonline.com/your_tenant

validate_authority

bool

valor padrão: None

(opcional) Ativa ou desativa a validação de autoridade. Esse parâmetro padrão é true.

cache

TokenCache

valor padrão: None

(opcional) Define o cache de token usado por esta instância authenticationContext. Se esse parâmetro não estiver definido, um padrão será usado. As instâncias de cache só são usadas por essa instância do AuthenticationContext e não são compartilhadas, a menos que elas sejam passadas manualmente durante a construção de outros AuthenticationContexts.

api_version

valor padrão: None

(opcional) Especifica a versão da API usando na transmissão. Historicamente, ele tem um valor padrão codificado como "1.0". Os desenvolvedores foram incentivados a defini-lo como Nenhum explicitamente, o que significa que a versão subjacente da API será escolhida automaticamente. A partir do ADAL Python 1.0, esse valor padrão se torna Nenhum.

timeout

valor padrão: None

(opcional) solicita o tempo limite. Quanto tempo aguardar o servidor enviar dados antes de desistir, como um float ou uma tupla (tempo limite de conexão, tempo limite de leitura ).

enable_pii

valor padrão: False

(opcional) A menos que isso esteja definido como True, não haverá informações de identificação pessoal (PII) gravadas no log.

verify_ssl

valor padrão: None

(opcional) solicitações verificam. Um booliano, nesse caso, controla se verificamos o certificado TLS do servidor ou uma cadeia de caracteres, nesse caso, ele deve ser um caminho para um pacote de AC a ser usado. Se esse valor não for fornecido e ADAL_PYTHON_SSL_NO_VERIFY env varaible for definido, o comportamento será equivalente a verify_ssl=False.

proxies

valor padrão: None

(opcional) solicita proxies. Protocolo de mapeamento de dicionário para a URL do proxy. Para obter detalhes, consulte http://docs.python-requests.org/en/master/user/advanced/#proxies.

Métodos

acquire_token	Obtém um token para um determinado recurso por meio de tokens armazenados em cache.
acquire_token_with_authorization_code	Obtém um token para um determinado recurso por meio do código de autorização para um aplicativo de servidor.
acquire_token_with_client_certificate	Obtém um token para um determinado recurso por meio de credenciais de certificado
acquire_token_with_client_credentials	Obtém um token para um determinado recurso por meio de credenciais de cliente.
acquire_token_with_device_code	Obtém um novo token de acesso usando por meio de um código de dispositivo.
acquire_token_with_refresh_token	Obtém um token para um determinado recurso por meio de tokens de atualização
acquire_token_with_username_password	Obtém um token para um determinado recurso por meio de credentails de usuário.
acquire_user_code	Obtém as informações de código do usuário que contém user_code, device_code para autenticar o usuário no dispositivo.
cancel_request_to_get_token_with_device_code	Cancela a solicitação de sondagem para obter o token com o código do dispositivo.

acquire_token

Obtém um token para um determinado recurso por meio de tokens armazenados em cache.

acquire_token(resource, user_id, client_id)

Parâmetros

resource

str

Obrigatório

Um URI que identifica o recurso para o qual o token é válido.

user_id

str

Obrigatório

O nome de usuário do usuário em nome desse aplicativo está se autenticando.

client_id

str

Obrigatório

A ID do cliente OAuth do aplicativo de chamada.

Retornos

dic com várias chaves, incluem "accessToken" e "refreshToken".

acquire_token_with_authorization_code

Obtém um token para um determinado recurso por meio do código de autorização para um aplicativo de servidor.

acquire_token_with_authorization_code(authorization_code, redirect_uri, resource, client_id, client_secret=None, code_verifier=None)

Parâmetros

authorization_code

str

Obrigatório

Um código de autorização retornado de um cliente.

redirect_uri

str

Obrigatório

o uri de redirecionamento que foi usado na chamada de autorização.

resource

str

Obrigatório

Um URI que identifica o recurso para o qual o token é válido.

client_id

str

Obrigatório

A ID do cliente OAuth do aplicativo de chamada.

client_secret

str

valor padrão: None

(somente para clientes confidenciais) O segredo do cliente OAuth do aplicativo de chamada. Se esse parâmetro não for definido, o padrão será None

code_verifier

str

valor padrão: None

(opcional) O verificador de código que foi usado para obter o código de autorização se o PKCE foi usado na solicitação de concessão de código de autorização. (geralmente usado por clientes públicos) Se esse parâmetro não for definido, o padrão será None

Retornos

dict com várias chaves, incluem "accessToken" e "refreshToken".

acquire_token_with_client_certificate

Obtém um token para um determinado recurso por meio de credenciais de certificado

acquire_token_with_client_certificate(resource, client_id, certificate, thumbprint, public_certificate=None)

Parâmetros

resource

str

Obrigatório

Um URI que identifica o recurso para o qual o token é válido.

client_id

str

Obrigatório

A ID do cliente OAuth do aplicativo de chamada.

certificate

str

Obrigatório

Uma chave privada de certificado codificado em PEM.

thumbprint

str

Obrigatório

impressão digital codificada em hex do certificado.

public_certificate

valor padrão: None

se não for Nenhum, ele será enviado ao serviço para nome da entidade e autenticação baseada em emissor, que é para dar suporte a rolamentos automáticos de certificado. O valor deve corresponder ao parâmetro de chave privada do certificado.

Retornos

dict com várias chaves, incluem "accessToken".

acquire_token_with_client_credentials

Obtém um token para um determinado recurso por meio de credenciais de cliente.

acquire_token_with_client_credentials(resource, client_id, client_secret)

Parâmetros

resource

str

Obrigatório

Um URI que identifica o recurso para o qual o token é válido.

client_id

str

Obrigatório

A ID do cliente OAuth do aplicativo de chamada.

client_secret

str

Obrigatório

O segredo do cliente OAuth do aplicativo de chamada.

Retornos

dict com várias chaves, incluem "accessToken".

acquire_token_with_device_code

Obtém um novo token de acesso usando por meio de um código de dispositivo.

acquire_token_with_device_code(resource, user_code_info, client_id)

Parâmetros

resource

str

Obrigatório

Um URI que identifica o recurso para o qual o token é válido.

user_code_info

dict

Obrigatório

As informações de código da invocação de "acquire_user_code"

client_id

str

Obrigatório

A ID do cliente OAuth do aplicativo de chamada.

Retornos

dict com várias chaves, incluem "accessToken" e "refreshToken".

acquire_token_with_refresh_token

Obtém um token para um determinado recurso por meio de tokens de atualização

acquire_token_with_refresh_token(refresh_token, client_id, resource, client_secret=None)

Parâmetros

refresh_token

str

Obrigatório

Um token de atualização retornado em uma resposta tokne de uma invocação anterior de acquireToken.

client_id

str

Obrigatório

A ID do cliente OAuth do aplicativo de chamada.

resource

str

Obrigatório

Um URI que identifica o recurso para o qual o token é válido.

client_secret

str

valor padrão: None

(opcional) O segredo do cliente OAuth do aplicativo de chamada.

Retornos

dict com várias chaves, incluem "accessToken" e "refreshToken".

acquire_token_with_username_password

Obtém um token para um determinado recurso por meio de credentails de usuário.

acquire_token_with_username_password(resource, username, password, client_id)

Parâmetros

resource

str

Obrigatório

Um URI que identifica o recurso para o qual o token é válido.

username

str

Obrigatório

O nome de usuário do usuário em nome desse aplicativo está se autenticando.

password

str

Obrigatório

A senha do usuário chamado no parâmetro username.

client_id

str

Obrigatório

A ID do cliente OAuth do aplicativo de chamada.

Retornos

dict com várias chaves, incluem "accessToken" e "refreshToken".

acquire_user_code

Obtém as informações de código do usuário que contém user_code, device_code para autenticar o usuário no dispositivo.

acquire_user_code(resource, client_id, language=None)

Parâmetros

resource

str

Obrigatório

Um URI que identifica o recurso para o qual o device_code e user_code é válido.

client_id

str

Obrigatório

A ID do cliente OAuth do aplicativo de chamada.

language

str

valor padrão: None

O código de idioma que especifica como a mensagem deve ser localizada.

Retornos

o dict contém código e uri para os usuários fazerem logon por meio do navegador.

cancel_request_to_get_token_with_device_code

Cancela a solicitação de sondagem para obter o token com o código do dispositivo.

cancel_request_to_get_token_with_device_code(user_code_info)

Parâmetros

user_code_info

dict

Obrigatório

As informações de código da invocação de "acquire_user_code"

Retornos

Nenhum

Atributos

options