64 строки
5.6 KiB
YAML
64 строки
5.6 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.identity.DeviceCodeCredential"
|
|
fullName: "com.azure.identity.DeviceCodeCredential"
|
|
name: "DeviceCodeCredential"
|
|
nameWithType: "DeviceCodeCredential"
|
|
summary: "An AAD credential that acquires a token with a device code for an AAD application."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedMembers:
|
|
- "java.lang.Object.clone()"
|
|
- "java.lang.Object.equals(java.lang.Object)"
|
|
- "java.lang.Object.finalize()"
|
|
- "java.lang.Object.getClass()"
|
|
- "java.lang.Object.hashCode()"
|
|
- "java.lang.Object.notify()"
|
|
- "java.lang.Object.notifyAll()"
|
|
- "java.lang.Object.toString()"
|
|
- "java.lang.Object.wait()"
|
|
- "java.lang.Object.wait(long)"
|
|
- "java.lang.Object.wait(long,int)"
|
|
syntax: "public class DeviceCodeCredential implements TokenCredential"
|
|
methods:
|
|
- uid: "com.azure.identity.DeviceCodeCredential.authenticate()"
|
|
fullName: "com.azure.identity.DeviceCodeCredential.authenticate()"
|
|
name: "authenticate()"
|
|
nameWithType: "DeviceCodeCredential.authenticate()"
|
|
summary: "Authenticates a user via the device code flow."
|
|
syntax: "public Mono<AuthenticationRecord> authenticate()"
|
|
desc: "Authenticates a user via the device code flow.\n\nThe credential acquires a verification URL and code from the Azure Active Directory. The user must browse to the URL, enter the code, and authenticate with Azure Active Directory. If the user authenticates successfully, the credential receives an access token."
|
|
returns:
|
|
description: "The <xref uid=\"com.azure.identity.AuthenticationRecord\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AuthenticationRecord\"></xref> which can be used to silently authenticate the account\n on future execution if persistent caching was configured via\n <xref uid=\"com.azure.identity.DeviceCodeCredentialBuilder.tokenCachePersistenceOptions(com.azure.identity.TokenCachePersistenceOptions)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DeviceCodeCredentialBuilder#tokenCachePersistenceOptions(TokenCachePersistenceOptions)\"></xref>\n when credential was instantiated."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.identity.AuthenticationRecord?alt=com.azure.identity.AuthenticationRecord&text=AuthenticationRecord\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.identity.DeviceCodeCredential.authenticate(com.azure.core.credential.TokenRequestContext)"
|
|
fullName: "com.azure.identity.DeviceCodeCredential.authenticate(TokenRequestContext request)"
|
|
name: "authenticate(TokenRequestContext request)"
|
|
nameWithType: "DeviceCodeCredential.authenticate(TokenRequestContext request)"
|
|
summary: "Authenticates a user via the device code flow."
|
|
parameters:
|
|
- description: "The details of the authentication request."
|
|
name: "request"
|
|
type: "<xref href=\"com.azure.core.credential.TokenRequestContext?alt=com.azure.core.credential.TokenRequestContext&text=TokenRequestContext\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<AuthenticationRecord> authenticate(TokenRequestContext request)"
|
|
desc: "Authenticates a user via the device code flow.\n\nThe credential acquires a verification URL and code from the Azure Active Directory. The user must browse to the URL, enter the code, and authenticate with Azure Active Directory. If the user authenticates successfully, the credential receives an access token."
|
|
returns:
|
|
description: "The <xref uid=\"com.azure.identity.AuthenticationRecord\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AuthenticationRecord\"></xref> which can be used to silently authenticate the account\n on future execution if persistent caching was configured via\n <xref uid=\"com.azure.identity.DeviceCodeCredentialBuilder.tokenCachePersistenceOptions(com.azure.identity.TokenCachePersistenceOptions)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DeviceCodeCredentialBuilder#tokenCachePersistenceOptions(TokenCachePersistenceOptions)\"></xref>\n when credential was instantiated."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.identity.AuthenticationRecord?alt=com.azure.identity.AuthenticationRecord&text=AuthenticationRecord\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.identity.DeviceCodeCredential.getToken(com.azure.core.credential.TokenRequestContext)"
|
|
fullName: "com.azure.identity.DeviceCodeCredential.getToken(TokenRequestContext request)"
|
|
name: "getToken(TokenRequestContext request)"
|
|
nameWithType: "DeviceCodeCredential.getToken(TokenRequestContext request)"
|
|
parameters:
|
|
- name: "request"
|
|
type: "<xref href=\"com.azure.core.credential.TokenRequestContext?alt=com.azure.core.credential.TokenRequestContext&text=TokenRequestContext\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<AccessToken> getToken(TokenRequestContext request)"
|
|
returns:
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.credential.AccessToken?alt=com.azure.core.credential.AccessToken&text=AccessToken\" data-throw-if-not-resolved=\"False\" />>"
|
|
type: "class"
|
|
desc: "An AAD credential that acquires a token with a device code for an AAD application."
|
|
implements:
|
|
- "<xref href=\"com.azure.core.credential.TokenCredential?alt=com.azure.core.credential.TokenCredential&text=TokenCredential\" data-throw-if-not-resolved=\"False\" />"
|
|
metadata: {}
|
|
package: "com.azure.identity"
|
|
artifact: com.azure:azure-identity:1.6.0
|