AuthenticationContext Classe
Obtém tokens de autenticação do Azure Active Directory.
Para utilizações, consulte a pasta "sample" em: https://github.com/AzureAD/azure-activedirectory-library-for-python
Cria um novo objeto AuthenticationContext.
Por predefinição, a autoridade será verificada numa lista de autoridades conhecidas do Azure Active Directory. Se a autoridade não for reconhecida como uma destas autoridades conhecidas, a aquisição de tokens falhará. Este comportamento pode ser desativado através do parâmetro validate_authority abaixo.
- Herança
-
builtins.objectAuthenticationContext
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
Um URL que identifica uma autoridade de tokens. Deve ser do formato https://login.microsoftonline.com/your_tenant
- validate_authority
- bool
(opcional) Ativa ou desativa a validação da autoridade. Este parâmetro predefinido é verdadeiro.
- cache
- TokenCache
(opcional) Define a cache de tokens utilizada por esta instância AuthenticationContext. Se este parâmetro não estiver definido, é utilizada uma predefinição. As instâncias de cache só são utilizadas por essa instância do AuthenticationContext e não são partilhadas, a menos que tenha sido transmitida manualmente durante a construção de outras AuthenticationContexts.
- api_version
(opcional) Especifica a versão da API através do cabo. Historicamente, tem um valor predefinido codificado como "1,0". Os programadores foram encorajados a defini-lo explicitamente como Nenhum, o que significa que a versão da API subjacente será escolhida automaticamente. A partir do ADAL Python 1.0, este valor predefinido torna-se Nenhum.
- timeout
(opcional) pedidos tempo limite. Quanto tempo esperar que o servidor envie dados antes de desistir, como um flutuante ou uma cadeia de identificação (tempo limite de ligação, tempo limite de leitura ).
- enable_pii
(opcional) A menos que esteja definido como Verdadeiro, não haverá nenhuma Informação Pessoalmente Identificável (PII) escrita no registo.
- verify_ssl
(opcional) os pedidos verificam. Ou um valor booleano, caso em que controla se verificamos o certificado TLS do servidor ou uma cadeia, caso em que tem de ser um caminho para um pacote de AC utilizar. Se este valor não for fornecido e ADAL_PYTHON_SSL_NO_VERIFY env varaible estiver definido, o comportamento é equivalente a verify_ssl=Falso.
- proxies
(opcional) solicita proxies. Protocolo de mapeamento do dicionário para o URL do proxy. Veja http://docs.python-requests.org/en/master/user/advanced/#proxies para obter detalhes.
Métodos
| acquire_token |
Obtém um token para um determinado recurso através de tokens em cache. |
| acquire_token_with_authorization_code |
Obtém um token para um determinado recurso através de código de autorização para uma aplicação de servidor. |
| acquire_token_with_client_certificate |
Obtém um token para um determinado recurso através de credenciais de certificado |
| acquire_token_with_client_credentials |
Obtém um token para um determinado recurso através de credenciais de cliente. |
| acquire_token_with_device_code |
Obtém um novo token de acesso através de um código de dispositivo. |
| acquire_token_with_refresh_token |
Obtém um token para um determinado recurso através de tokens de atualização |
| acquire_token_with_username_password |
Obtém um token para um determinado recurso através de credentails de utilizador. |
| acquire_user_code |
Obtém as informações de código de utilizador que contêm user_code, device_code para autenticar o utilizador no dispositivo. |
| cancel_request_to_get_token_with_device_code |
Cancela o pedido de consulta para obter o token com o código do dispositivo. |
acquire_token
Obtém um token para um determinado recurso através de tokens em cache.
acquire_token(resource, user_id, client_id)Parâmetros
- user_id
- str
O nome de utilizador do utilizador em nome desta aplicação está a autenticar.
Devoluções
dic com várias chaves, inclua "accessToken" e "refreshToken".
acquire_token_with_authorization_code
Obtém um token para um determinado recurso através de código de autorização para uma aplicação de servidor.
acquire_token_with_authorization_code(authorization_code, redirect_uri, resource, client_id, client_secret=None, code_verifier=None)Parâmetros
- client_secret
- str
(apenas para clientes confidenciais) O segredo do cliente OAuth da aplicação de chamadas. Este parâmetro, se não estiver definido, é predefinido como Nenhum
- code_verifier
- str
(opcional) O verificador de código que foi utilizado para obter o código de autorização se o PKCE tiver sido utilizado no pedido de concessão de código de autorização. (normalmente utilizado por clientes públicos) Este parâmetro, se não estiver definido, é predefinido como Nenhum
Devoluções
dict com várias chaves, inclua "accessToken" e "refreshToken".
acquire_token_with_client_certificate
Obtém um token para um determinado recurso através de credenciais de certificado
acquire_token_with_client_certificate(resource, client_id, certificate, thumbprint, public_certificate=None)Parâmetros
- public_certificate
se não for Nenhum, será enviado para o serviço para o nome do requerente e autenticação baseada no emissor, que é para suportar os lançamentos automáticos de certificados. O valor tem de corresponder ao parâmetro de chave privada do certificado.
Devoluções
dict com várias chaves, inclua "accessToken".
acquire_token_with_client_credentials
Obtém um token para um determinado recurso através de credenciais de cliente.
acquire_token_with_client_credentials(resource, client_id, client_secret)Parâmetros
Devoluções
dict com várias chaves, inclua "accessToken".
acquire_token_with_device_code
Obtém um novo token de acesso através de um código de dispositivo.
acquire_token_with_device_code(resource, user_code_info, client_id)Parâmetros
Devoluções
dict com várias chaves, inclua "accessToken" e "refreshToken".
acquire_token_with_refresh_token
Obtém um token para um determinado recurso através de tokens de atualização
acquire_token_with_refresh_token(refresh_token, client_id, resource, client_secret=None)Parâmetros
- refresh_token
- str
Um token de atualização devolvido numa resposta de tokne de uma invocação anterior de acquireToken.
- client_secret
- str
(opcional) O segredo do cliente OAuth da aplicação de chamadas.
Devoluções
dict com várias chaves, inclua "accessToken" e "refreshToken".
acquire_token_with_username_password
Obtém um token para um determinado recurso através de credentails de utilizador.
acquire_token_with_username_password(resource, username, password, client_id)Parâmetros
- username
- str
O nome de utilizador do utilizador em nome desta aplicação está a autenticar.
- password
- str
A palavra-passe do utilizador com o nome no parâmetro de nome de utilizador.
Devoluções
dict com várias chaves, inclua "accessToken" e "refreshToken".
acquire_user_code
Obtém as informações de código de utilizador que contêm user_code, device_code para autenticar o utilizador no dispositivo.
acquire_user_code(resource, client_id, language=None)Parâmetros
- resource
- str
Um URI que identifica o recurso para o qual o device_code e user_code é válido.
- language
- str
O código de idioma a especificar como a mensagem deve ser localizada.
Devoluções
o dict contém código e uri para os utilizadores iniciarem sessão através do browser.
cancel_request_to_get_token_with_device_code
Cancela o pedido de consulta para obter o token com o código do dispositivo.
cancel_request_to_get_token_with_device_code(user_code_info)Parâmetros
Devoluções
Nenhuma
Atributos
options
Azure SDK for Python
Comentários
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja: https://aka.ms/ContentUserFeedback.
Submeter e ver comentários