com.orange.webcom.sdk

Interface OnAuth.Identity

Enclosing interface:

OnAuth

public OnAuth.Identity

Identity data associated to an authenticated user.

Method Summary

Modifier and Type	Method and Description
(package private) java.lang.String	getAccessToken() Gets the OAuth access token attached to this interface OnAuth.Identity instance when available. This piece of information is available only when authenticating using OAuth2 login.
(package private) java.util.List<com.orange.webcom.sdk.OnAuth.Identity.Context>	getContext()
(package private) java.util.Date	getCreatedAt() Gets the creation date of the webcom user account attached to this interface OnAuth.Identity instance.
(package private) java.lang.String	getDisplayName() Gets the display name attached to this interface OnAuth.Identity instance when available. Its availability depends on the identity provider that forged this interface OnAuth.Identity instance.
(package private) java.lang.String	getEmail() Gets the email address attached to this interface OnAuth.Identity instance when available. Its availability depends on the identity provider that forged this interface OnAuth.Identity instance. The email is always available when authenticating with email/password. The email may be available when authenticating with an OAuth2 provider.
(package private) java.util.Date	getExpires() Gets the expiration date of the authentication token attached to this interface OnAuth.Identity instance when available. Note that it may be missing, typically in return of the com.orange.webcom.sdk.Webcom$addIdentity(java.lang.String,com.orange.webcom.sdk.AuthDetails,com.orange.webcom.sdk.OnAuth) method, which doesn't authenticate the user.
(package private) JSONValue	getJSONProviderProfile() Gets the provider profile data of this interface OnAuth.Identity instance as a interface JSONValue. It is null if no provider profile is attached to this instance.
(package private) java.lang.String	getProvider() Gets the identifier of the identity provider that forged this interface OnAuth.Identity instance. The returned value closely depends on the used authentication method: Anonymous login: anonymous Email/password login: password OAuth2 login: google, facebook, orange... Mobile Connect login: mobileconnect OIDC login: oidc. Implicit login: wassup Custom login: custom.
(package private) java.lang.Object	getProviderProfile() Deprecated.
(package private) java.lang.String	getProviderUid() Gets the unique identifier attributed by the identity provider that forged this interface OnAuth.Identity instance. The returned value is specific to each identity provider and is not guaranteed to be unique across them. If you need a unique user identifier, used com.orange.webcom.sdk.OnAuth.Identity$getUid().
(package private) java.lang.String	getUid() Gets the unique identifier of the webcom user account attached to this interface OnAuth.Identity instance.
(package private) java.lang.String	getWebcomAuthToken() Gets the Webcom authentication token attached to this interface OnAuth.Identity instance when available. Note that it may be missing, typically in return of the com.orange.webcom.sdk.Webcom$addIdentity(java.lang.String,com.orange.webcom.sdk.AuthDetails,com.orange.webcom.sdk.OnAuth) method, which doesn't authenticate the user.

Method Detail

getUid

@NonNull
java.lang.String getUid()

Gets the unique identifier of the webcom user account attached to this interface OnAuth.Identity instance.

Returns:

org.jetbrains.dokka.NodeRenderContent@45c928a: The identifier of the account attached to this interface OnAuth.Identity instance

See Also:

interface OnAuth.Identity

getProvider

@NonNull
java.lang.String getProvider()

Gets the identifier of the identity provider that forged this interface OnAuth.Identity instance. The returned value closely depends on the used authentication method:

• Anonymous login: anonymous
• Email/password login: password
• OAuth2 login: google, facebook, orange...
• Mobile Connect login: mobileconnect
• OIDC login: oidc.
• Implicit login: wassup
• Custom login: custom.

Returns:

org.jetbrains.dokka.NodeRenderContent@6a123c82: The identifier of the identity provider that forged this interface OnAuth.Identity instance

See Also:

interface OnAuth.Identity

getProviderUid

@NonNull
java.lang.String getProviderUid()

Gets the unique identifier attributed by the identity provider that forged this interface OnAuth.Identity instance. The returned value is specific to each identity provider and is not guaranteed to be unique across them. If you need a unique user identifier, used com.orange.webcom.sdk.OnAuth.Identity$getUid().

Returns:

org.jetbrains.dokka.NodeRenderContent@24ea0280: The identifier attributed by the identity provider that forged this interface OnAuth.Identity instance

See Also:

interface OnAuth.Identity, com.orange.webcom.sdk.OnAuth.Identity$getUid()

getCreatedAt

@NonNull
java.util.Date getCreatedAt()

Gets the creation date of the webcom user account attached to this interface OnAuth.Identity instance.

Returns:

org.jetbrains.dokka.NodeRenderContent@1f3723e2: The creation date of the account attached to this interface OnAuth.Identity instance

See Also:

interface OnAuth.Identity

getExpires

@Nullable
java.util.Date getExpires()

Gets the expiration date of the authentication token attached to this interface OnAuth.Identity instance when available. Note that it may be missing, typically in return of the com.orange.webcom.sdk.Webcom$addIdentity(java.lang.String,com.orange.webcom.sdk.AuthDetails,com.orange.webcom.sdk.OnAuth) method, which doesn't authenticate the user.

Returns:

org.jetbrains.dokka.NodeRenderContent@7f9f3a4c: The expiration date of the authentication token attached to this interface OnAuth.Identity instance or null if not available

See Also:

interface OnAuth.Identity, com.orange.webcom.sdk.Webcom$addIdentity(java.lang.String,com.orange.webcom.sdk.AuthDetails,com.orange.webcom.sdk.OnAuth)

getEmail

@Nullable
java.lang.String getEmail()

Gets the email address attached to this interface OnAuth.Identity instance when available. Its availability depends on the identity provider that forged this interface OnAuth.Identity instance. The email is always available when authenticating with email/password. The email may be available when authenticating with an OAuth2 provider.

Returns:

org.jetbrains.dokka.NodeRenderContent@492ff11: The email address of this interface OnAuth.Identity instance or null if not available

See Also:

interface OnAuth.Identity, interface OnAuth.Identity

getDisplayName

@Nullable
java.lang.String getDisplayName()

Gets the display name attached to this interface OnAuth.Identity instance when available. Its availability depends on the identity provider that forged this interface OnAuth.Identity instance.

Returns:

org.jetbrains.dokka.NodeRenderContent@70980301: The display name of this interface OnAuth.Identity instance or null if not available

See Also:

interface OnAuth.Identity, interface OnAuth.Identity

getAccessToken

@Nullable
java.lang.String getAccessToken()

Gets the OAuth access token attached to this interface OnAuth.Identity instance when available. This piece of information is available only when authenticating using OAuth2 login.

Returns:

org.jetbrains.dokka.NodeRenderContent@569606c3: The access token attached to this interface OnAuth.Identity instance or null if not available

See Also:

interface OnAuth.Identity

getWebcomAuthToken

@Nullable
java.lang.String getWebcomAuthToken()

Gets the Webcom authentication token attached to this interface OnAuth.Identity instance when available. Note that it may be missing, typically in return of the com.orange.webcom.sdk.Webcom$addIdentity(java.lang.String,com.orange.webcom.sdk.AuthDetails,com.orange.webcom.sdk.OnAuth) method, which doesn't authenticate the user.

Returns:

org.jetbrains.dokka.NodeRenderContent@50dd0b07: The authentication token attached to this interface OnAuth.Identity instance or null if not available

See Also:

interface OnAuth.Identity, com.orange.webcom.sdk.Webcom$addIdentity(java.lang.String,com.orange.webcom.sdk.AuthDetails,com.orange.webcom.sdk.OnAuth)

getProviderProfile

@Nullable
java.lang.Object getProviderProfile()

Deprecated.

Gets the provider profile data of this interface OnAuth.Identity instance as a interface JSONValue. It is null if either no provider profile is attached to this instance or it is not a regular JSON object.

Returns:

org.jetbrains.dokka.NodeRenderContent@43240c7a: The provider profile data of this interface OnAuth.Identity instance

See Also:

interface OnAuth.Identity, interface JSONValue

getJSONProviderProfile

@Nullable
JSONValue getJSONProviderProfile()

Gets the provider profile data of this interface OnAuth.Identity instance as a interface JSONValue. It is null if no provider profile is attached to this instance.

Returns:

org.jetbrains.dokka.NodeRenderContent@73948f14: The provider profile data of this interface OnAuth.Identity instance

See Also:

interface OnAuth.Identity, interface JSONValue

getContext

java.util.List<com.orange.webcom.sdk.OnAuth.Identity.Context> getContext()