Class App.Builder

  • Enclosing class:
    App

    public static class App.Builder
    extends Object
    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • id

        public App.Builder id​(String id)
        Unique identifier for the SCIM Resource as defined by the Service Provider.

        Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider’s entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier.

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: always - type: string - uniqueness: global

        Parameters:
        id - the value to set
        Returns:
        this builder
      • ocid

        public App.Builder ocid​(String ocid)
        Unique OCI identifier for the SCIM Resource.

        *SCIM++ Properties:** - caseExact: true - idcsSearchable: true - multiValued: false - mutability: immutable - required: false - returned: default - type: string - uniqueness: global

        Parameters:
        ocid - the value to set
        Returns:
        this builder
      • schemas

        public App.Builder schemas​(List<String> schemas)
        REQUIRED.

        The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \“enterprise\” extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: true - mutability: readWrite - required: true - returned: default - type: string - uniqueness: none

        Parameters:
        schemas - the value to set
        Returns:
        this builder
      • idcsPreventedOperations

        public App.Builder idcsPreventedOperations​(List<IdcsPreventedOperations> idcsPreventedOperations)
        Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.

        *SCIM++ Properties:** - idcsSearchable: false - multiValued: true - mutability: readOnly - required: false - returned: request - type: string - uniqueness: none

        Parameters:
        idcsPreventedOperations - the value to set
        Returns:
        this builder
      • tags

        public App.Builder tags​(List<Tags> tags)
        A list of tags on this resource.

        *SCIM++ Properties:** - idcsCompositeKey: [key, value] - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: request - type: complex - uniqueness: none

        Parameters:
        tags - the value to set
        Returns:
        this builder
      • deleteInProgress

        public App.Builder deleteInProgress​(Boolean deleteInProgress)
        A boolean flag indicating this resource in the process of being deleted.

        Usually set to true when synchronous deletion of the resource would take too long.

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean - uniqueness: none

        Parameters:
        deleteInProgress - the value to set
        Returns:
        this builder
      • idcsLastUpgradedInRelease

        public App.Builder idcsLastUpgradedInRelease​(String idcsLastUpgradedInRelease)
        The release number when the resource was upgraded.

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: request - type: string - uniqueness: none

        Parameters:
        idcsLastUpgradedInRelease - the value to set
        Returns:
        this builder
      • domainOcid

        public App.Builder domainOcid​(String domainOcid)
        OCI Domain Id (ocid) in which the resource lives.

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        domainOcid - the value to set
        Returns:
        this builder
      • compartmentOcid

        public App.Builder compartmentOcid​(String compartmentOcid)
        OCI Compartment Id (ocid) in which the resource lives.

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        compartmentOcid - the value to set
        Returns:
        this builder
      • tenancyOcid

        public App.Builder tenancyOcid​(String tenancyOcid)
        OCI Tenant Id (ocid) in which the resource lives.

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        tenancyOcid - the value to set
        Returns:
        this builder
      • meterAsOPCService

        public App.Builder meterAsOPCService​(Boolean meterAsOPCService)
        Indicates whether the application is billed as an OPCService.

        If true, customer is not billed for runtime operations of the app.

        *Added In:** 18.4.2

        *SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: always - type: boolean - uniqueness: none

        Parameters:
        meterAsOPCService - the value to set
        Returns:
        this builder
      • name

        public App.Builder name​(String name)
        Name of the application.

        Also serves as username if the application authenticates to Oracle Public Cloud infrastructure. This name may not be user-friendly and cannot be changed once an App is created.

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: immutable - required: false - returned: default - type: string - uniqueness: server

        Parameters:
        name - the value to set
        Returns:
        this builder
      • clientSecret

        public App.Builder clientSecret​(String clientSecret)
        This value is the credential of this App, which this App supplies as a password when this App authenticates to the Oracle Public Cloud infrastructure.

        This value is also the client secret of this App when it acts as an OAuthClient.

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - idcsSensitive: none - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        clientSecret - the value to set
        Returns:
        this builder
      • hashedClientSecret

        public App.Builder hashedClientSecret​(String hashedClientSecret)
        Hashed Client Secret.

        This hash-value is used to verify the ‘clientSecret’ credential of this App

        *Added In:** 2106240046

        *SCIM++ Properties:** - idcsSearchable: false - idcsSensitive: hash_sc - multiValued: false - mutability: readOnly - required: false - returned: request - type: string - uniqueness: none

        Parameters:
        hashedClientSecret - the value to set
        Returns:
        this builder
      • displayName

        public App.Builder displayName​(String displayName)
        Display name of the application.

        Display name is intended to be user-friendly, and an administrator can change the value at any time.

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: true - returned: always - type: string - uniqueness: server

        Parameters:
        displayName - the value to set
        Returns:
        this builder
      • description

        public App.Builder description​(String description)
        Description of the application.

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        description - the value to set
        Returns:
        this builder
      • idTokenEncAlgo

        public App.Builder idTokenEncAlgo​(String idTokenEncAlgo)
        Encryption Alogrithm to use for encrypting ID token.

        *Added In:** 2010242156

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        idTokenEncAlgo - the value to set
        Returns:
        this builder
      • delegatedServiceNames

        public App.Builder delegatedServiceNames​(List<String> delegatedServiceNames)
        Service Names allow to use OCI signature for client authentication instead of client credentials

        *Added In:** 2207040824

        *SCIM++ Properties:** - caseExact: true - idcsSearchable: false - multiValued: true - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        delegatedServiceNames - the value to set
        Returns:
        this builder
      • active

        public App.Builder active​(Boolean active)
        If true, this App is able to participate in runtime services, such as automatic-login, OAuth, and SAML.

        If false, all runtime services are disabled for this App, and only administrative operations can be performed.

        *SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

        Parameters:
        active - the value to set
        Returns:
        this builder
      • appIcon

        public App.Builder appIcon​(String appIcon)
        Application icon.

        *SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: request - type: string - uniqueness: none

        Parameters:
        appIcon - the value to set
        Returns:
        this builder
      • appThumbnail

        public App.Builder appThumbnail​(String appThumbnail)
        Application thumbnail.

        *SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: request - type: string - uniqueness: none

        Parameters:
        appThumbnail - the value to set
        Returns:
        this builder
      • migrated

        public App.Builder migrated​(Boolean migrated)
        If true, this App was migrated from an earlier version of Oracle Public Cloud infrastructure (and may therefore require special handling from runtime services such as OAuth or SAML).

        If false, this App requires no special handling from runtime services.

        *SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean - uniqueness: none

        Parameters:
        migrated - the value to set
        Returns:
        this builder
      • infrastructure

        public App.Builder infrastructure​(Boolean infrastructure)
        If true, this App is an internal infrastructure App.

        *SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean - uniqueness: none

        Parameters:
        infrastructure - the value to set
        Returns:
        this builder
      • isLoginTarget

        public App.Builder isLoginTarget​(Boolean isLoginTarget)
        If true, this App allows runtime services to log end users into this App automatically.

        *SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

        Parameters:
        isLoginTarget - the value to set
        Returns:
        this builder
      • showInMyApps

        public App.Builder showInMyApps​(Boolean showInMyApps)
        If true, this app will be displayed in the MyApps page of each end-user who has access to the App.

        *Added In:** 18.1.2

        *SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

        Parameters:
        showInMyApps - the value to set
        Returns:
        this builder
      • loginMechanism

        public App.Builder loginMechanism​(App.LoginMechanism loginMechanism)
        The protocol that runtime services will use to log end users in to this App automatically.

        If ‘OIDC’, then runtime services use the OpenID Connect protocol. If ‘SAML’, then runtime services use Security Assertion Markup Language protocol.

        *SCIM++ Properties:** - caseExact: true - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        loginMechanism - the value to set
        Returns:
        this builder
      • landingPageUrl

        public App.Builder landingPageUrl​(String landingPageUrl)
        The URL of the landing page for this App, which is the first page that an end user should see if runtime services log that end user in to this App automatically.

        *SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        landingPageUrl - the value to set
        Returns:
        this builder
      • productLogoUrl

        public App.Builder productLogoUrl​(String productLogoUrl)
        Application Logo URL

        *Added In:** 19.2.1

        *SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        productLogoUrl - the value to set
        Returns:
        this builder
      • privacyPolicyUrl

        public App.Builder privacyPolicyUrl​(String privacyPolicyUrl)
        Privacy Policy URL

        *Added In:** 19.2.1

        *SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        privacyPolicyUrl - the value to set
        Returns:
        this builder
      • termsOfServiceUrl

        public App.Builder termsOfServiceUrl​(String termsOfServiceUrl)
        Terms of Service URL

        *Added In:** 19.2.1

        *SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        termsOfServiceUrl - the value to set
        Returns:
        this builder
      • contactEmailAddress

        public App.Builder contactEmailAddress​(String contactEmailAddress)
        Contact Email Address

        *Added In:** 19.2.1

        *SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        contactEmailAddress - the value to set
        Returns:
        this builder
      • productName

        public App.Builder productName​(String productName)
        Product Name

        *Added In:** 19.2.1

        *SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        productName - the value to set
        Returns:
        this builder
      • homePageUrl

        public App.Builder homePageUrl​(String homePageUrl)
        Home Page URL

        *Added In:** 19.2.1

        *SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        homePageUrl - the value to set
        Returns:
        this builder
      • isFormFill

        public App.Builder isFormFill​(Boolean isFormFill)
        If true, this application acts as FormFill Application

        *SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

        Parameters:
        isFormFill - the value to set
        Returns:
        this builder
      • isOAuthClient

        public App.Builder isOAuthClient​(Boolean isOAuthClient)
        If true, this application acts as an OAuth Client

        *SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

        Parameters:
        isOAuthClient - the value to set
        Returns:
        this builder
      • isRadiusApp

        public App.Builder isRadiusApp​(Boolean isRadiusApp)
        If true, this application acts as an Radius App

        *Added In:** 20.1.3

        *SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

        Parameters:
        isRadiusApp - the value to set
        Returns:
        this builder
      • clientType

        public App.Builder clientType​(App.ClientType clientType)
        Specifies the type of access that this App has when it acts as an OAuthClient.

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        clientType - the value to set
        Returns:
        this builder
      • redirectUris

        public App.Builder redirectUris​(List<String> redirectUris)
        OPTIONAL.

        Each value is a URI within this App. This attribute is required when this App acts as an OAuthClient and is involved in three-legged flows (authorization-code flows).

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: true - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        redirectUris - the value to set
        Returns:
        this builder
      • allUrlSchemesAllowed

        public App.Builder allUrlSchemesAllowed​(Boolean allUrlSchemesAllowed)
        If true, indicates that the system should allow all URL-schemes within each value of the ‘redirectUris’ attribute.

        Also indicates that the system should not attempt to confirm that each value of the ‘redirectUris’ attribute is a valid URI. In particular, the system should not confirm that the domain component of the URI is a top-level domain and the system should not confirm that the hostname portion is a valid system that is reachable over the network.

        *SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

        Parameters:
        allUrlSchemesAllowed - the value to set
        Returns:
        this builder
      • logoutUri

        public App.Builder logoutUri​(String logoutUri)
        OAuth will use this URI to logout if this App wants to participate in SSO, and if this App’s session gets cleared as part of global logout.

        Note: This attribute is used only if this App acts as an OAuthClient.

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        logoutUri - the value to set
        Returns:
        this builder
      • postLogoutRedirectUris

        public App.Builder postLogoutRedirectUris​(List<String> postLogoutRedirectUris)
        Each value of this attribute is the URI of a landing page within this App.

        It is used only when this App, acting as an OAuthClient, initiates the logout flow and wants to be redirected back to one of its landing pages.

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: true - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        postLogoutRedirectUris - the value to set
        Returns:
        this builder
      • allowedGrants

        public App.Builder allowedGrants​(List<String> allowedGrants)
        List of grant-types that this App is allowed to use when it acts as an OAuthClient.

        *SCIM++ Properties:** - caseExact: true - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        allowedGrants - the value to set
        Returns:
        this builder
      • allowedOperations

        public App.Builder allowedOperations​(List<App.AllowedOperations> allowedOperations)
        OPTIONAL.

        Required only when this App acts as an OAuthClient. Supported values are ‘introspect’ and ‘onBehalfOfUser’. The value ‘introspect’ allows the client to look inside the access-token. The value ‘onBehalfOfUser’ overrides how the client’s privileges are combined with the privileges of the Subject User. Ordinarily, authorization calculates the set of effective privileges as the intersection of the client’s privileges and the user’s privileges. The value ‘onBehalfOf’ indicates that authorization should ignore the privileges of the client and use only the user’s privileges to calculate the effective privileges.

        *SCIM++ Properties:** - caseExact: true - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        allowedOperations - the value to set
        Returns:
        this builder
      • clientIPChecking

        public App.Builder clientIPChecking​(App.ClientIPChecking clientIPChecking)
        Network Perimeters checking mode

        *Added In:** 2010242156

        *SCIM++ Properties:** - caseExact: true - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        clientIPChecking - the value to set
        Returns:
        this builder
      • isOPCService

        public App.Builder isOPCService​(Boolean isOPCService)
        If true, this application is an Oracle Public Cloud service-instance.

        *SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean - uniqueness: none

        Parameters:
        isOPCService - the value to set
        Returns:
        this builder
      • isUnmanagedApp

        public App.Builder isUnmanagedApp​(Boolean isUnmanagedApp)
        If true, indicates that this application accepts an Oracle Cloud Identity Service User as a login-identity (does not require an account) and relies for authorization on the User’s memberships in AppRoles.

        *SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: immutable - required: false - returned: default - type: boolean - uniqueness: none

        Parameters:
        isUnmanagedApp - the value to set
        Returns:
        this builder
      • allowAccessControl

        public App.Builder allowAccessControl​(Boolean allowAccessControl)
        If true, any managed App that is based on this template is checked for access control that is, access to this app is subject to successful authorization at SSO service, viz.

        app grants to start with.

        *SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

        Parameters:
        allowAccessControl - the value to set
        Returns:
        this builder
      • isOAuthResource

        public App.Builder isOAuthResource​(Boolean isOAuthResource)
        If true, indicates that this application acts as an OAuth Resource.

        *SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

        Parameters:
        isOAuthResource - the value to set
        Returns:
        this builder
      • accessTokenExpiry

        public App.Builder accessTokenExpiry​(Integer accessTokenExpiry)
        Expiry-time in seconds for an Access Token.

        Any token that allows access to this App will expire after the specified duration.

        *SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: integer - uniqueness: none

        Parameters:
        accessTokenExpiry - the value to set
        Returns:
        this builder
      • refreshTokenExpiry

        public App.Builder refreshTokenExpiry​(Integer refreshTokenExpiry)
        Expiry-time in seconds for a Refresh Token.

        Any token that allows access to this App, once refreshed, will expire after the specified duration.

        *SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: integer - uniqueness: none

        Parameters:
        refreshTokenExpiry - the value to set
        Returns:
        this builder
      • allowOffline

        public App.Builder allowOffline​(Boolean allowOffline)
        If true, indicates that the Refresh Token is allowed when this App acts as an OAuth Resource.

        *SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

        Parameters:
        allowOffline - the value to set
        Returns:
        this builder
      • callbackServiceUrl

        public App.Builder callbackServiceUrl​(String callbackServiceUrl)
        Callback Service URL

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        callbackServiceUrl - the value to set
        Returns:
        this builder
      • audience

        public App.Builder audience​(String audience)
        The base URI for all of the scopes defined in this App.

        The value of ‘audience’ is combined with the ‘value’ of each scope to form an ‘fqs’ or fully qualified scope.

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        audience - the value to set
        Returns:
        this builder
      • isMobileTarget

        public App.Builder isMobileTarget​(Boolean isMobileTarget)
        If true, indicates that the App should be visible in each end-user’s mobile application.

        *SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

        Parameters:
        isMobileTarget - the value to set
        Returns:
        this builder
      • loginPageUrl

        public App.Builder loginPageUrl​(String loginPageUrl)
        This attribute specifies the URL of the page that the App uses when an end-user signs in to that App.

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        loginPageUrl - the value to set
        Returns:
        this builder
      • linkingCallbackUrl

        public App.Builder linkingCallbackUrl​(String linkingCallbackUrl)
        This attribute specifies the callback URL for the social linking operation.

        *Added In:** 18.2.4

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        linkingCallbackUrl - the value to set
        Returns:
        this builder
      • logoutPageUrl

        public App.Builder logoutPageUrl​(String logoutPageUrl)
        This attribute specifies the URL of the page that the App uses when an end-user signs out.

        *Added In:** 17.4.2

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        logoutPageUrl - the value to set
        Returns:
        this builder
      • errorPageUrl

        public App.Builder errorPageUrl​(String errorPageUrl)
        This attribute specifies the URL of the page to which an application will redirect an end-user in case of error.

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        errorPageUrl - the value to set
        Returns:
        this builder
      • isSamlServiceProvider

        public App.Builder isSamlServiceProvider​(Boolean isSamlServiceProvider)
        If true, then this App acts as a SAML Service Provider.

        *SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

        Parameters:
        isSamlServiceProvider - the value to set
        Returns:
        this builder
      • isWebTierPolicy

        public App.Builder isWebTierPolicy​(Boolean isWebTierPolicy)
        If true, the webtier policy is active

        *SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

        Parameters:
        isWebTierPolicy - the value to set
        Returns:
        this builder
      • isKerberosRealm

        public App.Builder isKerberosRealm​(Boolean isKerberosRealm)
        If true, indicates that this App supports Kerberos Authentication

        *SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

        Parameters:
        isKerberosRealm - the value to set
        Returns:
        this builder
      • icon

        public App.Builder icon​(String icon)
        URL of application icon.

        *SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: reference - uniqueness: none

        Parameters:
        icon - the value to set
        Returns:
        this builder
      • isAliasApp

        public App.Builder isAliasApp​(Boolean isAliasApp)
        If true, this App is an AliasApp and it cannot be granted to an end-user directly.

        *SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: immutable - required: false - returned: always - type: boolean - uniqueness: none

        Parameters:
        isAliasApp - the value to set
        Returns:
        this builder
      • isManagedApp

        public App.Builder isManagedApp​(Boolean isManagedApp)
        If true, indicates that access to this App requires an account.

        That is, in order to log in to the App, a User must use an application-specific identity that is maintained in the remote identity-repository of that App.

        *SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean - uniqueness: none

        Parameters:
        isManagedApp - the value to set
        Returns:
        this builder
      • serviceTypeURN

        public App.Builder serviceTypeURN​(String serviceTypeURN)
        This Uniform Resource Name (URN) value identifies the type of Oracle Public Cloud service of which this app is an instance.

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        serviceTypeURN - the value to set
        Returns:
        this builder
      • serviceTypeVersion

        public App.Builder serviceTypeVersion​(String serviceTypeVersion)
        This value specifies the version of the Oracle Public Cloud service of which this App is an instance

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        serviceTypeVersion - the value to set
        Returns:
        this builder
      • isObligationCapable

        public App.Builder isObligationCapable​(Boolean isObligationCapable)
        This flag indicates if the App is capable of validating obligations with the token for allowing access to the App.

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

        Parameters:
        isObligationCapable - the value to set
        Returns:
        this builder
      • readyToUpgrade

        public App.Builder readyToUpgrade​(Boolean readyToUpgrade)
        If true, this App requires an upgrade and mandates attention from application administrator.

        The flag is used by UI to indicate this app is ready to upgrade.

        *SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean - uniqueness: none

        Parameters:
        readyToUpgrade - the value to set
        Returns:
        this builder
      • trustScope

        public App.Builder trustScope​(App.TrustScope trustScope)
        Indicates the scope of trust for this App when acting as an OAuthClient.

        A value of ‘Explicit’ indicates that the App is allowed to access only the scopes of OAuthResources that are explicitly specified as ‘allowedScopes’. A value of ‘Account’ indicates that the App is allowed implicitly to access any scope of any OAuthResource within the same Oracle Cloud Account. A value of ‘Tags’ indicates that the App is allowed to access any scope of any OAuthResource with a matching tag within the same Oracle Cloud Account. A value of ‘Default’ indicates that the Tenant default trust scope configured in the Tenant Settings is used.

        *Added In:** 17.4.2

        *SCIM++ Properties:** - caseExact: true - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        trustScope - the value to set
        Returns:
        this builder
      • isDatabaseService

        public App.Builder isDatabaseService​(Boolean isDatabaseService)
        If true, this application acts as database service Application

        *Added In:** 18.2.2

        *SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - type: boolean

        Parameters:
        isDatabaseService - the value to set
        Returns:
        this builder
      • secondaryAudiences

        public App.Builder secondaryAudiences​(List<String> secondaryAudiences)
        A list of secondary audiences–additional URIs to be added automatically to any OAuth token that allows access to this App.

        Note: This attribute is used mainly for backward compatibility in certain Oracle Public Cloud Apps.

        *Deprecated Since: 18.2.6**

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: true - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        secondaryAudiences - the value to set
        Returns:
        this builder
      • isEnterpriseApp

        public App.Builder isEnterpriseApp​(Boolean isEnterpriseApp)
        If true, this app acts as Enterprise app with Authentication and URL Authz policy.

        *Added In:** 19.2.1

        *SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

        Parameters:
        isEnterpriseApp - the value to set
        Returns:
        this builder
      • bypassConsent

        public App.Builder bypassConsent​(Boolean bypassConsent)
        If true, indicates that consent should be skipped for all scopes

        *Added In:** 19.2.1

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

        Parameters:
        bypassConsent - the value to set
        Returns:
        this builder
      • disableKmsiTokenAuthentication

        public App.Builder disableKmsiTokenAuthentication​(Boolean disableKmsiTokenAuthentication)
        Indicates whether the application is allowed to be access using kmsi token.

        *Added In:** 2111190457

        *SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: always - type: boolean - uniqueness: none

        Parameters:
        disableKmsiTokenAuthentication - the value to set
        Returns:
        this builder
      • isMulticloudServiceApp

        public App.Builder isMulticloudServiceApp​(Boolean isMulticloudServiceApp)
        If true, indicates the app is used for multicloud service integration.

        *Added In:** 2301202328

        *SCIM++ Properties:** - idcsSearchable: true - multiValued: false - mutability: immutable - required: false - returned: default - type: boolean - uniqueness: none

        Parameters:
        isMulticloudServiceApp - the value to set
        Returns:
        this builder
      • appsNetworkPerimeters

        public App.Builder appsNetworkPerimeters​(List<AppAppsNetworkPerimeters> appsNetworkPerimeters)
        Network Perimeter

        *Added In:** 2010242156

        *SCIM++ Properties:** - idcsCompositeKey: [value] - multiValued: true - mutability: readWrite - required: false - returned: default - type: complex

        Parameters:
        appsNetworkPerimeters - the value to set
        Returns:
        this builder
      • cloudControlProperties

        public App.Builder cloudControlProperties​(List<AppCloudControlProperties> cloudControlProperties)
        A collection of arbitrary properties that scope the privileges of a cloud-control App.

        *Added In:** 18.4.2

        *SCIM++ Properties:** - idcsCompositeKey: [name] - idcsSearchable: false - multiValued: true - mutability: readOnly - required: false - returned: request - type: complex - uniqueness: none

        Parameters:
        cloudControlProperties - the value to set
        Returns:
        this builder
      • editableAttributes

        public App.Builder editableAttributes​(List<AppEditableAttributes> editableAttributes)
        App attributes editable by subject

        *Added In:** 18.2.6

        *SCIM++ Properties:** - caseExact: false - idcsCompositeKey: [name] - idcsSearchable: false - multiValued: true - mutability: readOnly - required: false - returned: request - type: complex - uniqueness: none

        Parameters:
        editableAttributes - the value to set
        Returns:
        this builder
      • protectableSecondaryAudiences

        public App.Builder protectableSecondaryAudiences​(List<AppProtectableSecondaryAudiences> protectableSecondaryAudiences)
        A list of secondary audiences–additional URIs to be added automatically to any OAuth token that allows access to this App.

        Note: This attribute is used mainly for backward compatibility in certain Oracle Public Cloud Apps.

        *Added In:** 18.2.2

        *SCIM++ Properties:** - caseExact: false - idcsCompositeKey: [value] - idcsSearchable: false - multiValued: true - mutability: readWrite - required: false - returned: default - type: complex - uniqueness: none

        Parameters:
        protectableSecondaryAudiences - the value to set
        Returns:
        this builder
      • allowedTags

        public App.Builder allowedTags​(List<AppAllowedTags> allowedTags)
        A list of tags, acting as an OAuthClient, this App is allowed to access.

        *Added In:** 17.4.6

        *SCIM++ Properties:** - idcsCompositeKey: [key, value] - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: default - type: complex - uniqueness: none

        Parameters:
        allowedTags - the value to set
        Returns:
        this builder
      • trustPolicies

        public App.Builder trustPolicies​(List<AppTrustPolicies> trustPolicies)
        Trust Policies.

        *SCIM++ Properties:** - idcsCompositeKey: [value] - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: default - type: complex

        Parameters:
        trustPolicies - the value to set
        Returns:
        this builder
      • identityProviders

        public App.Builder identityProviders​(List<AppIdentityProviders> identityProviders)
        A list of IdentityProvider assigned to app.

        A user trying to access this app will be automatically redirected to configured IdP during the authentication phase, before being able to access App.

        *SCIM++ Properties:** - idcsCompositeKey: [value] - idcsSearchable: false - multiValued: true - mutability: readWrite - required: false - returned: request - type: complex

        Parameters:
        identityProviders - the value to set
        Returns:
        this builder
      • accounts

        public App.Builder accounts​(List<AppAccounts> accounts)
        Accounts of App

        *SCIM++ Properties:** - idcsCompositeKey: [value] - idcsSearchable: true - multiValued: true - mutability: readOnly - required: false - returned: request - type: complex - uniqueness: none

        Parameters:
        accounts - the value to set
        Returns:
        this builder
      • grants

        public App.Builder grants​(List<AppGrants> grants)
        Grants assigned to the app

        *SCIM++ Properties:** - idcsCompositeKey: [value] - idcsSearchable: true - multiValued: true - mutability: readOnly - required: false - returned: request - type: complex - uniqueness: none

        Parameters:
        grants - the value to set
        Returns:
        this builder
      • serviceParams

        public App.Builder serviceParams​(List<AppServiceParams> serviceParams)
        Custom attribute that is required to compute other attribute values during app creation.

        *SCIM++ Properties:** - idcsCompositeKey: [name] - idcsSearchable: false - multiValued: true - mutability: readWrite - required: false - returned: always - type: complex - uniqueness: none

        Parameters:
        serviceParams - the value to set
        Returns:
        this builder
      • attrRenderingMetadata

        public App.Builder attrRenderingMetadata​(List<AppAttrRenderingMetadata> attrRenderingMetadata)
        Label for the attribute to be shown in the UI.

        *SCIM++ Properties:** - idcsCompositeKey: [name] - idcsSearchable: false - multiValued: true - mutability: immutable - required: false - returned: default - type: complex - uniqueness: none

        Parameters:
        attrRenderingMetadata - the value to set
        Returns:
        this builder
      • grantedAppRoles

        public App.Builder grantedAppRoles​(List<AppGrantedAppRoles> grantedAppRoles)
        A list of AppRoles that are granted to this App (and that are defined by other Apps).

        Within the Oracle Public Cloud infrastructure, this allows AppID-based association. Such an association allows this App to act as a consumer and thus to access resources of another App that acts as a producer.

        *SCIM++ Properties:** - caseExact: true - idcsCompositeKey: [value] - idcsSearchable: true - multiValued: true - mutability: readOnly - required: false - returned: default - type: complex - uniqueness: none

        Parameters:
        grantedAppRoles - the value to set
        Returns:
        this builder
      • allowedScopes

        public App.Builder allowedScopes​(List<AppAllowedScopes> allowedScopes)
        A list of scopes (exposed by this App or by other Apps) that this App is allowed to access when it acts as an OAuthClient.

        *SCIM++ Properties:** - caseExact: true - idcsCompositeKey: [fqs] - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: default - type: complex - uniqueness: none

        Parameters:
        allowedScopes - the value to set
        Returns:
        this builder
      • certificates

        public App.Builder certificates​(List<AppCertificates> certificates)
        Each value of this attribute represent a certificate that this App uses when it acts as an OAuthClient.

        *SCIM++ Properties:** - caseExact: false - idcsCompositeKey: [certAlias] - idcsSearchable: false - multiValued: true - mutability: readWrite - required: false - returned: default - type: complex - uniqueness: none

        Parameters:
        certificates - the value to set
        Returns:
        this builder
      • aliasApps

        public App.Builder aliasApps​(List<AppAliasApps> aliasApps)
        Each value of this internal attribute refers to an Oracle Public Cloud infrastructure App on which this App depends.

        *SCIM++ Properties:** - caseExact: true - idcsCompositeKey: [value] - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: default - type: complex - uniqueness: none

        Parameters:
        aliasApps - the value to set
        Returns:
        this builder
      • adminRoles

        public App.Builder adminRoles​(List<AppAdminRoles> adminRoles)
        A list of AppRoles defined by this UnmanagedApp.

        Membership in each of these AppRoles confers administrative privilege within this App.

        *SCIM++ Properties:** - idcsCompositeKey: [value] - idcsSearchable: false - multiValued: true - mutability: readOnly - required: false - returned: request - type: complex

        Parameters:
        adminRoles - the value to set
        Returns:
        this builder
      • userRoles

        public App.Builder userRoles​(List<AppUserRoles> userRoles)
        A list of AppRoles defined by this UnmanagedApp.

        Membership in each of these AppRoles confers end-user privilege within this App.

        *SCIM++ Properties:** - idcsCompositeKey: [value] - idcsSearchable: false - multiValued: true - mutability: readOnly - required: false - returned: request - type: complex

        Parameters:
        userRoles - the value to set
        Returns:
        this builder
      • scopes

        public App.Builder scopes​(List<AppScopes> scopes)
        Scopes defined by this App.

        Used when this App acts as an OAuth Resource.

        *SCIM++ Properties:** - caseExact: true - idcsCompositeKey: [value] - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: default - type: complex - uniqueness: none

        Parameters:
        scopes - the value to set
        Returns:
        this builder
      • urnIetfParamsScimSchemasOracleIdcsExtensionRadiusAppApp

        public App.Builder urnIetfParamsScimSchemasOracleIdcsExtensionRadiusAppApp​(AppExtensionRadiusAppApp urnIetfParamsScimSchemasOracleIdcsExtensionRadiusAppApp)
      • urnIetfParamsScimSchemasOracleIdcsExtensionSamlServiceProviderApp

        public App.Builder urnIetfParamsScimSchemasOracleIdcsExtensionSamlServiceProviderApp​(AppExtensionSamlServiceProviderApp urnIetfParamsScimSchemasOracleIdcsExtensionSamlServiceProviderApp)
      • urnIetfParamsScimSchemasOracleIdcsExtensionWebTierPolicyApp

        public App.Builder urnIetfParamsScimSchemasOracleIdcsExtensionWebTierPolicyApp​(AppExtensionWebTierPolicyApp urnIetfParamsScimSchemasOracleIdcsExtensionWebTierPolicyApp)
      • urnIetfParamsScimSchemasOracleIdcsExtensionManagedappApp

        public App.Builder urnIetfParamsScimSchemasOracleIdcsExtensionManagedappApp​(AppExtensionManagedappApp urnIetfParamsScimSchemasOracleIdcsExtensionManagedappApp)
      • urnIetfParamsScimSchemasOracleIdcsExtensionFormFillAppTemplateAppTemplate

        public App.Builder urnIetfParamsScimSchemasOracleIdcsExtensionFormFillAppTemplateAppTemplate​(AppExtensionFormFillAppTemplateAppTemplate urnIetfParamsScimSchemasOracleIdcsExtensionFormFillAppTemplateAppTemplate)
      • urnIetfParamsScimSchemasOracleIdcsExtensionOpcServiceApp

        public App.Builder urnIetfParamsScimSchemasOracleIdcsExtensionOpcServiceApp​(AppExtensionOpcServiceApp urnIetfParamsScimSchemasOracleIdcsExtensionOpcServiceApp)
      • urnIetfParamsScimSchemasOracleIdcsExtensionKerberosRealmApp

        public App.Builder urnIetfParamsScimSchemasOracleIdcsExtensionKerberosRealmApp​(AppExtensionKerberosRealmApp urnIetfParamsScimSchemasOracleIdcsExtensionKerberosRealmApp)
      • urnIetfParamsScimSchemasOracleIdcsExtensionRequestableApp

        public App.Builder urnIetfParamsScimSchemasOracleIdcsExtensionRequestableApp​(AppExtensionRequestableApp urnIetfParamsScimSchemasOracleIdcsExtensionRequestableApp)
      • urnIetfParamsScimSchemasOracleIdcsExtensionFormFillAppApp

        public App.Builder urnIetfParamsScimSchemasOracleIdcsExtensionFormFillAppApp​(AppExtensionFormFillAppApp urnIetfParamsScimSchemasOracleIdcsExtensionFormFillAppApp)
      • urnIetfParamsScimSchemasOracleIdcsExtensionDbcsApp

        public App.Builder urnIetfParamsScimSchemasOracleIdcsExtensionDbcsApp​(AppExtensionDbcsApp urnIetfParamsScimSchemasOracleIdcsExtensionDbcsApp)
      • urnIetfParamsScimSchemasOracleIdcsExtensionEnterpriseAppApp

        public App.Builder urnIetfParamsScimSchemasOracleIdcsExtensionEnterpriseAppApp​(AppExtensionEnterpriseAppApp urnIetfParamsScimSchemasOracleIdcsExtensionEnterpriseAppApp)
      • urnIetfParamsScimSchemasOracleIdcsExtensionOciTags

        public App.Builder urnIetfParamsScimSchemasOracleIdcsExtensionOciTags​(ExtensionOCITags urnIetfParamsScimSchemasOracleIdcsExtensionOciTags)
      • urnIetfParamsScimSchemasOracleIdcsExtensionMulticloudServiceAppApp

        public App.Builder urnIetfParamsScimSchemasOracleIdcsExtensionMulticloudServiceAppApp​(AppExtensionMulticloudServiceAppApp urnIetfParamsScimSchemasOracleIdcsExtensionMulticloudServiceAppApp)
      • build

        public App build()