azure-docs-sdk-java/docs-ref-autogen/com.microsoft.identity.clie...

113 строки
5.7 KiB
YAML

### YamlMime:JavaType
constructors:
- fullName: com.microsoft.identity.client.Account.Account( @Nullable final String clientInfo, @Nullable final IDToken homeTenantIdToken)
name: Account( @Nullable final String clientInfo, @Nullable final IDToken homeTenantIdToken)
nameWithType: Account.Account( @Nullable final String clientInfo, @Nullable final IDToken homeTenantIdToken)
parameters:
- name: clientInfo
type: <xref href="%40Nullable+final+String?alt=%40Nullable+final+String&text=%40Nullable+final+String" data-throw-if-not-resolved="False"/>
- name: homeTenantIdToken
type: <xref href="%40Nullable+final+IDToken?alt=%40Nullable+final+IDToken&text=%40Nullable+final+IDToken" data-throw-if-not-resolved="False"/>
syntax: public Account( @Nullable final String clientInfo, @Nullable final IDToken homeTenantIdToken)
uid: com.microsoft.identity.client.Account.Account(@Nullable final String,@Nullable final IDToken)
inheritances:
- <xref href="java.lang.Object" data-throw-if-not-resolved="False"/>
- <xref href="Serializable" data-throw-if-not-resolved="False"/>
- <xref href="com.microsoft.identity.client.IAccount?alt=com.microsoft.identity.client.IAccount&text=IAccount" data-throw-if-not-resolved="False"/>
methods:
- fullName: com.microsoft.identity.client.Account.getAuthority()
name: getAuthority()
nameWithType: Account.getAuthority()
overridden: com.microsoft.identity.client.IAccount.getAuthority()
returns:
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
syntax: public String getAuthority()
uid: com.microsoft.identity.client.Account.getAuthority()
- fullName: com.microsoft.identity.client.Account.getClaims()
name: getClaims()
nameWithType: Account.getClaims()
overridden: com.microsoft.identity.client.IClaimable.getClaims()
returns:
description: <p>The claims for this Account's IdToken or null, if no IdToken exists. </p>
type: <xref href="Map%3CString%2C+%3F%3E?alt=Map%3CString%2C+%3F%3E&text=Map%3CString%2C+%3F%3E" data-throw-if-not-resolved="False"/>
summary: >-
<p>Gets the claims associated to this Account's IdToken. In the case of the Microsoft Identity Platform, this value can be null if the home tenant has not been authorized.</p>
<p></p>
syntax: public Map<String, ?> getClaims()
uid: com.microsoft.identity.client.Account.getClaims()
- fullName: com.microsoft.identity.client.Account.getId()
name: getId()
nameWithType: Account.getId()
overridden: com.microsoft.identity.client.IAccount.getId()
returns:
description: <p>The id. </p>
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
summary: >-
<p>Gets the id of the account. </p>
<p>For the Microsoft Identity Platform: the OID of the account in its home tenant.</p>
<p></p>
syntax: public String getId()
uid: com.microsoft.identity.client.Account.getId()
- fullName: com.microsoft.identity.client.Account.getIdToken()
name: getIdToken()
nameWithType: Account.getIdToken()
overridden: com.microsoft.identity.client.IClaimable.getIdToken()
returns:
description: <p>The raw id_token. </p>
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
summary: >-
<p>Gets the JWT format id_token corresponding to this IClaimable. This value conforms to <a href="https://tools.ietf.org/html/rfc7519">RFC-7519</a> and is further specified according to <a href="https://openid.net/specs/openid-connect-core-1_0.html#IDToken">OpenID Connect Core</a>. </p>
<p>Note: MSAL does not validate the JWT token.</p>
<p></p>
syntax: public String getIdToken()
uid: com.microsoft.identity.client.Account.getIdToken()
- fullName: com.microsoft.identity.client.Account.getTenantId()
name: getTenantId()
nameWithType: Account.getTenantId()
overridden: com.microsoft.identity.client.IClaimable.getTenantId()
returns:
description: <p>The tid claim or "" (empty string) if not available. </p>
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
summary: >-
<p>Gets the tid claim associated with this IClaimable.</p>
<p></p>
syntax: public String getTenantId()
uid: com.microsoft.identity.client.Account.getTenantId()
- fullName: com.microsoft.identity.client.Account.getUsername()
name: getUsername()
nameWithType: Account.getUsername()
overridden: com.microsoft.identity.client.IClaimable.getUsername()
returns:
description: <p>The preferred_username claim or "" (empty string) if not available. </p>
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
summary: >-
<p>Gets the preferred_username claim associated with this IClaimable. </p>
<p>Note: On the Microsoft B2C Identity Platform, this claim may be unavailable when external identity providers are used.</p>
<p></p>
syntax: public String getUsername()
uid: com.microsoft.identity.client.Account.getUsername()
- fullName: com.microsoft.identity.client.Account.setHomeAccountId(@NonNull final String homeAccountId)
name: setHomeAccountId(@NonNull final String homeAccountId)
nameWithType: Account.setHomeAccountId(@NonNull final String homeAccountId)
parameters:
- name: homeAccountId
type: <xref href="%40NonNull+final+String?alt=%40NonNull+final+String&text=%40NonNull+final+String" data-throw-if-not-resolved="False"/>
syntax: public void setHomeAccountId(@NonNull final String homeAccountId)
uid: com.microsoft.identity.client.Account.setHomeAccountId(@NonNull final String)
nameWithType: Account
syntax: public class Account implements IAccount
type: class
uid: com.microsoft.identity.client.Account
fullName: com.microsoft.identity.client.Account
name: Account
package: com.microsoft.identity.client
metadata: {}