Compartir a través de

AuthenticationContext Clase

  • Referencia

Recupera tokens de autenticación de Azure Active Directory.

Para los usos, consulte la carpeta "sample" en: https://github.com/AzureAD/azure-activedirectory-library-for-python

Crea un nuevo objeto AuthenticationContext.

De forma predeterminada, la autoridad se comprobará con una lista de autoridades conocidas de Azure Active Directory. Si la autoridad no se reconoce como una de estas autoridades conocidas, se producirá un error en la adquisición de tokens. Este comportamiento se puede desactivar mediante el parámetro validate_authority siguiente.

Herencia
builtins.object
AuthenticationContext

Constructor

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

Parámetros

authority
str
Requerido

Dirección URL que identifica una entidad de token. Debe tener el formato . https://login.microsoftonline.com/your_tenant

validate_authority
bool
valor predeterminado: None

(opcional) Activa o desactiva la validación de autoridad. Este parámetro tiene como valor predeterminado true.

cache
TokenCache
valor predeterminado: None

(opcional) Establece la caché de tokens usada por esta instancia de AuthenticationContext. Si no se establece este parámetro, se usa un valor predeterminado. Esa instancia de AuthenticationContext solo usa instancias de caché y no se comparten a menos que se haya pasado manualmente durante la construcción de otros AuthenticationContexts.

api_version
valor predeterminado: None

(opcional) Especifica la versión de la API mediante en la conexión. Históricamente tiene un valor predeterminado codificado de forma rígida como "1.0". Se ha animado a los desarrolladores a establecerlo como Ninguno explícitamente, lo que significa que la versión de api subyacente se elegirá automáticamente. A partir de ADAL Python 1.0, este valor predeterminado se convierte en Ninguno.

timeout
valor predeterminado: None

(opcional) se ha agotado el tiempo de espera de las solicitudes. Cuánto tiempo debe esperar a que el servidor envíe datos antes de renunciar, como un valor flotante o una tupla (tiempo de espera de conexión, tiempo de espera de lectura).

enable_pii
valor predeterminado: False

(opcional) A menos que se establezca en True, no habrá ninguna información de identificación personal (PII) escrita en el registro.

verify_ssl
valor predeterminado: None

(opcional) las solicitudes comprueban. Un valor booleano, en cuyo caso controla si comprobamos el certificado TLS del servidor o una cadena, en cuyo caso debe ser una ruta de acceso a una agrupación de CA que se va a usar. Si no se proporciona este valor y se establece ADAL_PYTHON_SSL_NO_VERIFY varaible, el comportamiento es equivalente a verify_ssl=False.

proxies
valor predeterminado: None

(opcional) solicita servidores proxy. Protocolo de asignación de diccionario a la dirección URL del proxy. Para obtener información detallada, vea http://docs.python-requests.org/en/master/user/advanced/#proxies.

Métodos

acquire_token

Obtiene un token para un recurso determinado a través de tokens almacenados en caché.
acquire_token_with_authorization_code

Obtiene un token para un recurso determinado a través del código de autorización para una aplicación de servidor.
acquire_token_with_client_certificate

Obtiene un token para un recurso determinado mediante credenciales de certificado.
acquire_token_with_client_credentials

Obtiene un token para un recurso determinado mediante credenciales de cliente.
acquire_token_with_device_code

Obtiene un nuevo token de acceso mediante un código de dispositivo.
acquire_token_with_refresh_token

Obtiene un token para un recurso determinado a través de tokens de actualización.
acquire_token_with_username_password

Obtiene un token para un recurso determinado a través de credenciales de usuario.
acquire_user_code

Obtiene la información de código de usuario que contiene user_code, device_code para autenticar al usuario en el dispositivo.
cancel_request_to_get_token_with_device_code

Cancela la solicitud de sondeo para obtener el token con el código del dispositivo.

acquire_token

Obtiene un token para un recurso determinado a través de tokens almacenados en caché.

acquire_token(resource, user_id, client_id)

Parámetros

resource
str
Requerido

URI que identifica el recurso para el que el token es válido.

user_id
str
Requerido

El nombre de usuario del usuario en nombre de esta aplicación se autentica.

client_id
str
Requerido

Identificador de cliente de OAuth de la aplicación que realiza la llamada.

Devoluciones

dic con varias claves, incluyen "accessToken" y "refreshToken".

acquire_token_with_authorization_code

Obtiene un token para un recurso determinado a través del código de autorización para una aplicación 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
Requerido

Código de autorización devuelto por un cliente.

redirect_uri
str
Requerido

el URI de redireccionamiento que se usó en la llamada de autorización.

resource
str
Requerido

URI que identifica el recurso para el que el token es válido.

client_id
str
Requerido

Identificador de cliente de OAuth de la aplicación que realiza la llamada.

client_secret
str
valor predeterminado: None

(solo para clientes confidenciales) Secreto de cliente de OAuth de la aplicación que realiza la llamada. Este parámetro si no se establece, el valor predeterminado es None.

code_verifier
str
valor predeterminado: None

(opcional) Comprobador de código que se usó para obtener el código de autorización si se usó PKCE en la solicitud de concesión de código de autorización. (normalmente usado por clientes públicos) Este parámetro si no se establece, el valor predeterminado es None.

Devoluciones

dict con varias claves, incluyen "accessToken" y "refreshToken".

acquire_token_with_client_certificate

Obtiene un token para un recurso determinado mediante credenciales de certificado.

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

Parámetros

resource
str
Requerido

URI que identifica el recurso para el que el token es válido.

client_id
str
Requerido

Identificador de cliente de OAuth de la aplicación que realiza la llamada.

certificate
str
Requerido

Una clave privada de certificado con codificación PEM.

thumbprint
str
Requerido

Huella digital codificada hexadecimal del certificado.

public_certificate
valor predeterminado: None

si no es Ninguno, se enviará al servicio para el nombre del firmante y la autenticación basada en emisores, que es para admitir los lanzamientos automáticos de certificados. El valor debe coincidir con el parámetro de clave privada del certificado.

Devoluciones

dict con varias claves, incluyen "accessToken".

acquire_token_with_client_credentials

Obtiene un token para un recurso determinado mediante credenciales de cliente.

acquire_token_with_client_credentials(resource, client_id, client_secret)

Parámetros

resource
str
Requerido

URI que identifica el recurso para el que el token es válido.

client_id
str
Requerido

Identificador de cliente de OAuth de la aplicación que realiza la llamada.

client_secret
str
Requerido

Secreto de cliente de OAuth de la aplicación que realiza la llamada.

Devoluciones

dict con varias claves, incluyen "accessToken".

acquire_token_with_device_code

Obtiene un nuevo token de acceso mediante un código de dispositivo.

acquire_token_with_device_code(resource, user_code_info, client_id)

Parámetros

resource
str
Requerido

URI que identifica el recurso para el que el token es válido.

user_code_info
dict
Requerido

Información de código de la invocación de "acquire_user_code"

client_id
str
Requerido

Identificador de cliente de OAuth de la aplicación que realiza la llamada.

Devoluciones

dict con varias claves, incluyen "accessToken" y "refreshToken".

acquire_token_with_refresh_token

Obtiene un token para un recurso determinado a través de tokens de actualización.

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

Parámetros

refresh_token
str
Requerido

Token de actualización devuelto en una respuesta tokne de una invocación anterior de acquireToken.

client_id
str
Requerido

Identificador de cliente de OAuth de la aplicación que realiza la llamada.

resource
str
Requerido

URI que identifica el recurso para el que el token es válido.

client_secret
str
valor predeterminado: None

(opcional) Secreto de cliente de OAuth de la aplicación que realiza la llamada.

Devoluciones

dict con varias claves, incluyen "accessToken" y "refreshToken".

acquire_token_with_username_password

Obtiene un token para un recurso determinado a través de credenciales de usuario.

acquire_token_with_username_password(resource, username, password, client_id)

Parámetros

resource
str
Requerido

URI que identifica el recurso para el que el token es válido.

username
str
Requerido

El nombre de usuario del usuario en nombre de esta aplicación se autentica.

password
str
Requerido

Contraseña del usuario denominado en el parámetro username.

client_id
str
Requerido

Identificador de cliente de OAuth de la aplicación que realiza la llamada.

Devoluciones

dict con varias claves, incluyen "accessToken" y "refreshToken".

acquire_user_code

Obtiene la información de código de usuario que contiene user_code, device_code para autenticar al usuario en el dispositivo.

acquire_user_code(resource, client_id, language=None)

Parámetros

resource
str
Requerido

URI que identifica el recurso para el que el device_code y el user_code son válidos.

client_id
str
Requerido

Identificador de cliente de OAuth de la aplicación que realiza la llamada.

language
str
valor predeterminado: None

Código de idioma en el que se especifica cómo se debe localizar el mensaje.

Devoluciones

dict contiene código y URI para que los usuarios inicien sesión a través del explorador.

cancel_request_to_get_token_with_device_code

Cancela la solicitud de sondeo para obtener el token con el código del dispositivo.

cancel_request_to_get_token_with_device_code(user_code_info)

Parámetros

user_code_info
dict
Requerido

Información de código de la invocación de "acquire_user_code"

Devoluciones

None

Atributos

options