@Generated(value="OracleSDKGenerator",
comments="API Version: 20190506")
public final class UpdateAuthenticationProviderDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Properties to update an Authentication Provider.
Note: Objects should always be created or deserialized using the UpdateAuthenticationProviderDetails.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 UpdateAuthenticationProviderDetails.Builder, which maintain a
set of all explicitly set fields called UpdateAuthenticationProviderDetails.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).
| Modifier and Type | Class and Description |
|---|---|
static class |
UpdateAuthenticationProviderDetails.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
UpdateAuthenticationProviderDetails(String tokenEndpointUrl,
String authorizationEndpointUrl,
String shortAuthorizationCodeRequestUrl,
String revokeTokenEndpointUrl,
String clientId,
String clientSecret,
String scopes,
String subjectClaim,
Integer refreshTokenRetentionPeriodInDays,
String redirectUrl,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static UpdateAuthenticationProviderDetails.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getAuthorizationEndpointUrl()
The IDPs URL for the page that users authenticate with by entering the user name and
password.
|
String |
getClientId()
The client ID for the IDP application (OAuth Client) that was registered as described in
Identity Provider Registration.
|
String |
getClientSecret()
The client secret for the IDP application (OAuth Client) that was registered as described in
Identity Provider Registration.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Usage of predefined tag keys.
|
Map<String,String> |
getFreeformTags()
Simple key-value pair that is applied without any predefined name, type, or scope.
|
String |
getRedirectUrl()
The OAuth Redirect URL.
|
Integer |
getRefreshTokenRetentionPeriodInDays()
The number of days to keep the refresh token in the Digital Assistant cache.
|
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.
|
String |
getScopes()
A space-separated list of the scopes that must be included when Digital Assistant requests an
access token from the provider.
|
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).
|
String |
getSubjectClaim()
The access-token profile claim to use to identify the user.
|
String |
getTokenEndpointUrl()
The IDPs URL for requesting access tokens.
|
int |
hashCode() |
UpdateAuthenticationProviderDetails.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"tokenEndpointUrl","authorizationEndpointUrl","shortAuthorizationCodeRequestUrl","revokeTokenEndpointUrl","clientId","clientSecret","scopes","subjectClaim","refreshTokenRetentionPeriodInDays","redirectUrl","freeformTags","definedTags"}) public UpdateAuthenticationProviderDetails(String tokenEndpointUrl, String authorizationEndpointUrl, String shortAuthorizationCodeRequestUrl, String revokeTokenEndpointUrl, String clientId, String clientSecret, String scopes, String subjectClaim, Integer refreshTokenRetentionPeriodInDays, String redirectUrl, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)
public static UpdateAuthenticationProviderDetails.Builder builder()
Create a new builder.
public UpdateAuthenticationProviderDetails.Builder toBuilder()
public String getTokenEndpointUrl()
The IDPs URL for requesting access tokens.
public String getAuthorizationEndpointUrl()
The IDPs URL for the page that users authenticate with by entering the user name and password.
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.
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.
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.
public String getClientSecret()
The client secret for the IDP application (OAuth Client) that was registered as described in Identity Provider Registration. With Microsoft identity platform, use the application secret.
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’s necessary to get the refresh token (typically offline_access).
public String getSubjectClaim()
The access-token profile claim to use to identify the user.
public Integer getRefreshTokenRetentionPeriodInDays()
The number of days to keep the refresh token in the Digital Assistant cache.
public String getRedirectUrl()
The OAuth Redirect URL.
public Map<String,String> getFreeformTags()
Simple key-value pair that is applied without any predefined name, type, or scope. Example:
{"bar-key": "value"}
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"}}
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.