Package com.oracle.bmc.oda.model

Class AuthenticationProvider

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20190506")
public final class AuthenticationProvider
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Settings for the Authentication Provider.
    Note: Objects should always be created or deserialized using the AuthenticationProvider.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the AuthenticationProvider.Builder, which maintain a set of all explicitly set fields called AuthenticationProvider.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getId

        public String getId()
        Unique immutable identifier that was assigned when the Authentication Provider was created.
        Returns:
        the value

      • getGrantType

        public AuthenticationGrantType getGrantType()
        The grant type for the Authentication Provider.
        Returns:
        the value

      • getIdentityProvider

        public AuthenticationIdentityProvider getIdentityProvider()
        Which type of Identity Provider (IDP) you are using.
        Returns:
        the value

      • getName

        public String getName()
        A name to identify the Authentication Provider.
        Returns:
        the value

      • getTokenEndpointUrl

        public String getTokenEndpointUrl()
        The IDPs URL for requesting access tokens.
        Returns:
        the value

      • getAuthorizationEndpointUrl

        public String getAuthorizationEndpointUrl()
        The IDPs URL for the page that users authenticate with by entering the user name and password.
        Returns:
        the value

      • getShortAuthorizationCodeRequestUrl

        public String getShortAuthorizationCodeRequestUrl()
        A shortened version of the authorization URL, which you can get from a URL shortener service (one that allows you to send query parameters).

        You might need this because the generated authorization-code-request URL could be too long for SMS and older smart phones.

        Returns:
        the value

      • getRevokeTokenEndpointUrl

        public String getRevokeTokenEndpointUrl()
        If you want to revoke all the refresh tokens and access tokens of the logged-in user from a dialog flow, then you need the IDP’s revoke refresh token URL.

        If you provide this URL, then you can use the System.OAuth2ResetTokens component to revoke the user’s tokens for this service.

        Returns:
        the value

      • getClientId

        public String getClientId()
        The client ID for the IDP application (OAuth Client) that was registered as described in Identity Provider Registration.

        With Microsoft identity platform, use the application ID.

        Returns:
        the value

      • getScopes

        public String getScopes()
        A space-separated list of the scopes that must be included when Digital Assistant requests an access token from the provider.

        Include all the scopes that are required to access the resources. If refresh tokens are enabled, include the scope that\u2019s necessary to get the refresh token (typically offline_access).

        Returns:
        the value

      • getSubjectClaim

        public String getSubjectClaim()
        The access-token profile claim to use to identify the user.
        Returns:
        the value

      • getRefreshTokenRetentionPeriodInDays

        public Integer getRefreshTokenRetentionPeriodInDays()
        The number of days to keep the refresh token in the Digital Assistant cache.
        Returns:
        the value

      • getRedirectUrl

        public String getRedirectUrl()
        The OAuth Redirect URL.
        Returns:
        the value

      • getIsVisible

        public Boolean getIsVisible()
        Whether this Authentication Provider is visible in the ODA UI.
        Returns:
        the value

      • getLifecycleState

        public LifecycleState getLifecycleState()
        The Authentication Provider’s current state.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        When the resource was created.

        A date-time string as described in RFC 3339, section 14.29.

        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        When the resource was last updated.

        A date-time string as described in RFC 3339, section 14.29.

        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        Simple key-value pair that is applied without any predefined name, type, or scope.

        Example: {“bar-key”: “value”}

        Returns:
        the value

      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        Usage of predefined tag keys.

        These predefined keys are scoped to namespaces. Example: {“foo-namespace”: {“bar-key”: “value”}}

        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel