AuthenticationProvider.Builder (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.oda.model.AuthenticationProvider.Builder

Enclosing class:: AuthenticationProvider

public static class AuthenticationProvider.Builder
extends Object

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AuthenticationProvider.Builder`	`authorizationEndpointUrl(String authorizationEndpointUrl)` The IDPs URL for the page that users authenticate with by entering the user name and password.
`AuthenticationProvider`	`build()`
`AuthenticationProvider.Builder`	`clientId(String clientId)` The client ID for the IDP application (OAuth Client) that was registered as described in Identity Provider Registration.
`AuthenticationProvider.Builder`	`copy(AuthenticationProvider model)`
`AuthenticationProvider.Builder`	`definedTags(Map<String,Map<String,Object>> definedTags)` Usage of predefined tag keys.
`AuthenticationProvider.Builder`	`freeformTags(Map<String,String> freeformTags)` Simple key-value pair that is applied without any predefined name, type, or scope.
`AuthenticationProvider.Builder`	`grantType(AuthenticationGrantType grantType)` The grant type for the Authentication Provider.
`AuthenticationProvider.Builder`	`id(String id)` Unique immutable identifier that was assigned when the Authentication Provider was created.
`AuthenticationProvider.Builder`	`identityProvider(AuthenticationIdentityProvider identityProvider)` Which type of Identity Provider (IDP) you are using.
`AuthenticationProvider.Builder`	`isVisible(Boolean isVisible)` Whether this Authentication Provider is visible in the ODA UI.
`AuthenticationProvider.Builder`	`lifecycleState(LifecycleState lifecycleState)` The Authentication Provider’s current state.
`AuthenticationProvider.Builder`	`name(String name)` A name to identify the Authentication Provider.
`AuthenticationProvider.Builder`	`redirectUrl(String redirectUrl)` The OAuth Redirect URL.
`AuthenticationProvider.Builder`	`refreshTokenRetentionPeriodInDays(Integer refreshTokenRetentionPeriodInDays)` The number of days to keep the refresh token in the Digital Assistant cache.
`AuthenticationProvider.Builder`	`revokeTokenEndpointUrl(String revokeTokenEndpointUrl)` 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.
`AuthenticationProvider.Builder`	`scopes(String scopes)` A space-separated list of the scopes that must be included when Digital Assistant requests an access token from the provider.
`AuthenticationProvider.Builder`	`shortAuthorizationCodeRequestUrl(String shortAuthorizationCodeRequestUrl)` A shortened version of the authorization URL, which you can get from a URL shortener service (one that allows you to send query parameters).
`AuthenticationProvider.Builder`	`subjectClaim(String subjectClaim)` The access-token profile claim to use to identify the user.
`AuthenticationProvider.Builder`	`timeCreated(Date timeCreated)` When the resource was created.
`AuthenticationProvider.Builder`	`timeUpdated(Date timeUpdated)` When the resource was last updated.
`AuthenticationProvider.Builder`	`tokenEndpointUrl(String tokenEndpointUrl)` The IDPs URL for requesting access tokens.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - id
```
public AuthenticationProvider.Builder id(String id)
```
    Unique immutable identifier that was assigned when the Authentication Provider was created.
    
    Parameters:
    
    id - the value to set
    
    Returns:
    
    this builder
  - grantType
```
public AuthenticationProvider.Builder grantType(AuthenticationGrantType grantType)
```
    The grant type for the Authentication Provider.
    
    Parameters:
    
    grantType - the value to set
    
    Returns:
    
    this builder
  - identityProvider
```
public AuthenticationProvider.Builder identityProvider(AuthenticationIdentityProvider identityProvider)
```
    Which type of Identity Provider (IDP) you are using.
    
    Parameters:
    
    identityProvider - the value to set
    
    Returns:
    
    this builder
  - name
```
public AuthenticationProvider.Builder name(String name)
```
    A name to identify the Authentication Provider.
    
    Parameters:
    
    name - the value to set
    
    Returns:
    
    this builder
  - tokenEndpointUrl
```
public AuthenticationProvider.Builder tokenEndpointUrl(String tokenEndpointUrl)
```
    The IDPs URL for requesting access tokens.
    
    Parameters:
    
    tokenEndpointUrl - the value to set
    
    Returns:
    
    this builder
  - authorizationEndpointUrl
```
public AuthenticationProvider.Builder authorizationEndpointUrl(String authorizationEndpointUrl)
```
    The IDPs URL for the page that users authenticate with by entering the user name and password.
    
    Parameters:
    
    authorizationEndpointUrl - the value to set
    
    Returns:
    
    this builder
  - shortAuthorizationCodeRequestUrl
```
public AuthenticationProvider.Builder shortAuthorizationCodeRequestUrl(String shortAuthorizationCodeRequestUrl)
```
    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.
    
    Parameters:
    
    shortAuthorizationCodeRequestUrl - the value to set
    
    Returns:
    
    this builder
  - revokeTokenEndpointUrl
```
public AuthenticationProvider.Builder revokeTokenEndpointUrl(String revokeTokenEndpointUrl)
```
    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.
    
    Parameters:
    
    revokeTokenEndpointUrl - the value to set
    
    Returns:
    
    this builder
  - clientId
```
public AuthenticationProvider.Builder clientId(String clientId)
```
    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.
    
    Parameters:
    
    clientId - the value to set
    
    Returns:
    
    this builder
  - scopes
```
public AuthenticationProvider.Builder scopes(String scopes)
```
    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).
    
    Parameters:
    
    scopes - the value to set
    
    Returns:
    
    this builder
  - subjectClaim
```
public AuthenticationProvider.Builder subjectClaim(String subjectClaim)
```
    The access-token profile claim to use to identify the user.
    
    Parameters:
    
    subjectClaim - the value to set
    
    Returns:
    
    this builder
  - refreshTokenRetentionPeriodInDays
```
public AuthenticationProvider.Builder refreshTokenRetentionPeriodInDays(Integer refreshTokenRetentionPeriodInDays)
```
    The number of days to keep the refresh token in the Digital Assistant cache.
    
    Parameters:
    
    refreshTokenRetentionPeriodInDays - the value to set
    
    Returns:
    
    this builder
  - redirectUrl
```
public AuthenticationProvider.Builder redirectUrl(String redirectUrl)
```
    The OAuth Redirect URL.
    
    Parameters:
    
    redirectUrl - the value to set
    
    Returns:
    
    this builder
  - isVisible
```
public AuthenticationProvider.Builder isVisible(Boolean isVisible)
```
    Whether this Authentication Provider is visible in the ODA UI.
    
    Parameters:
    
    isVisible - the value to set
    
    Returns:
    
    this builder
  - lifecycleState
```
public AuthenticationProvider.Builder lifecycleState(LifecycleState lifecycleState)
```
    The Authentication Provider’s current state.
    
    Parameters:
    
    lifecycleState - the value to set
    
    Returns:
    
    this builder
  - timeCreated
```
public AuthenticationProvider.Builder timeCreated(Date timeCreated)
```
    When the resource was created. A date-time string as described in RFC 3339, section 14.29.
    
    Parameters:
    
    timeCreated - the value to set
    
    Returns:
    
    this builder
  - timeUpdated
```
public AuthenticationProvider.Builder timeUpdated(Date timeUpdated)
```
    When the resource was last updated. A date-time string as described in RFC 3339, section 14.29.
    
    Parameters:
    
    timeUpdated - the value to set
    
    Returns:
    
    this builder
  - freeformTags
```
public AuthenticationProvider.Builder freeformTags(Map<String,String> freeformTags)
```
    Simple key-value pair that is applied without any predefined name, type, or scope. Example: {"bar-key": "value"}
    
    Parameters:
    
    freeformTags - the value to set
    
    Returns:
    
    this builder
  - definedTags
```
public AuthenticationProvider.Builder definedTags(Map<String,Map<String,Object>> definedTags)
```
    Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace": {"bar-key": "value"}}
    
    Parameters:
    
    definedTags - the value to set
    
    Returns:
    
    this builder
  - build
```
public AuthenticationProvider build()
```
  - copy
```
public AuthenticationProvider.Builder copy(AuthenticationProvider model)
```

Class AuthenticationProvider.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

id

grantType

identityProvider

name

tokenEndpointUrl

authorizationEndpointUrl

shortAuthorizationCodeRequestUrl

revokeTokenEndpointUrl

clientId

scopes

subjectClaim

refreshTokenRetentionPeriodInDays

redirectUrl

isVisible

lifecycleState

timeCreated

timeUpdated

freeformTags

definedTags

build

copy