UsernamePasswordCredential 클래스
사용자 이름 및 암호를 사용하여 사용자를 인증합니다.
일반적으로 Microsoft는 다른 인증 흐름보다 보안이 떨어지므로 이러한 종류의 인증을 권장하지 않습니다.
이 자격 증명을 사용한 인증은 대화형이 아니므로 어떤 형태의 다단계 인증 또는 동의 프롬프트와 호환되지 않습니다. 애플리케이션에는 사용자 또는 디렉터리 관리자의 동의가 이미 있어야 합니다.
이 자격 증명은 회사 및 학교 계정만 인증할 수 있습니다. Microsoft 계정은 지원되지 않습니다. 계정 유형에 대한 자세한 내용은 Azure Active Directory 설명서를 참조하세요.
- 상속
-
azure.identity._internal.interactive.InteractiveCredentialUsernamePasswordCredential
생성자
UsernamePasswordCredential(client_id: str, username: str, password: str, **kwargs: Any)매개 변수
- authority
- str
Azure Active Directory 엔드포인트의 권한(예: "login.microsoftonline.com", 기본값인 Azure 퍼블릭 클라우드에 대한 기관). AzureAuthorityHosts 는 다른 클라우드에 대한 기관을 정의합니다.
- tenant_id
- str
테넌트 ID 또는 테넌트와 연결된 도메인입니다. 제공되지 않으면 기본적으로 Azure Active Directory 회사 또는 학교 계정만 지원하는 "조직" 테넌트가 사용됩니다.
- cache_persistence_options
- TokenCachePersistenceOptions
영구 토큰 캐싱에 대한 구성입니다. 지정되지 않은 경우 자격 증명은 메모리에 토큰을 캐시합니다.
- disable_instance_discovery
- bool
인증을 시도할 때 instance 검색이 수행되는지 여부를 결정합니다. 이를 true로 설정하면 instance 검색 및 기관 유효성 검사가 모두 비활성화됩니다. 이 기능은 프라이빗 클라우드 또는 Azure Stack과 같이 메타데이터 엔드포인트에 연결할 수 없는 시나리오에서 사용하기 위한 것입니다. instance 검색 프로세스에는 인증 기관의 유효성을 검사하기 위해 에서 https://login.microsoft.com/ 기관 메타데이터를 검색해야 합니다. 이를 True로 설정하면 권한의 유효성 검사가 비활성화됩니다. 따라서 구성된 기관 호스트가 유효하고 신뢰할 수 있는지 확인하는 것이 중요합니다.
자격 증명이 토큰을 획득할 수 있는 지정된 "tenant_id" 외에 테넌트도 지정합니다. 자격 증명이 애플리케이션에서 액세스할 수 있는 테넌트의 토큰을 획득할 수 있도록 와일드카드 값 "*"을 추가합니다.
예제
UsernamePasswordCredential을 만듭니다.
from azure.identity import UsernamePasswordCredential
credential = UsernamePasswordCredential(
client_id="<client_id>",
username="<username>",
password="<password>",
)
메서드
| authenticate |
사용자를 대화형으로 인증합니다. |
| close | |
| get_token |
범위에 대한 액세스 토큰을 요청 합니다. 이 메서드는 Azure SDK 클라이언트에서 자동으로 호출됩니다. |
authenticate
사용자를 대화형으로 인증합니다.
authenticate(**kwargs: Any) -> AuthenticationRecord매개 변수
는 에서 제공하는 것과 같이 인증 중에 요청할 범위입니다 scopes. 제공된 경우 성공적인 인증은 이러한 범위에 대한 액세스 토큰을 캐시합니다.
반환 형식
예외
인증에 실패했습니다. 오류의 message 특성은 이유를 제공합니다.
close
get_token
범위에 대한 액세스 토큰을 요청 합니다.
이 메서드는 Azure SDK 클라이언트에서 자동으로 호출됩니다.
get_token(*scopes: str, claims: str | None = None, tenant_id: str | None = None, **kwargs: Any) -> AccessToken매개 변수
- scopes
- str
액세스 토큰에 대한 원하는 범위입니다. 이 메서드에는 하나 이상의 scope 필요합니다. 범위에 대한 자세한 내용은 를 참조하세요 https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.
- claims
- str
토큰에 필요한 추가 클레임(예: 권한 부여 실패 후 리소스 공급자의 클레임 챌린지에 반환된 클레임)
- tenant_id
- str
토큰 요청에 포함할 선택적 테넌트입니다.
- enable_cae
- bool
는 요청된 토큰에 대해 CAE(연속 액세스 평가)를 사용하도록 설정할지 여부를 나타냅니다. 기본값은 False입니다.
반환
원하는 범위가 있는 액세스 토큰입니다.
반환 형식
예외
필요한 데이터, 상태 또는 플랫폼 지원이 부족하여 자격 증명이 인증을 시도할 수 없습니다.
인증에 실패했습니다. 오류의 message 특성은 이유를 제공합니다.
토큰을 획득하려면 사용자 상호 작용이 필요하며 자격 증명은 이를 자동으로 시작하지 않도록 구성됩니다. 호출
대화형 인증을 시작합니다.
피드백
출시 예정: 2024년 내내 콘텐츠에 대한 피드백 메커니즘으로 GitHub 문제를 단계적으로 폐지하고 이를 새로운 피드백 시스템으로 바꿀 예정입니다. 자세한 내용은 다음을 참조하세요. https://aka.ms/ContentUserFeedback
다음에 대한 사용자 의견 제출 및 보기