authentication (oracleAppServerSSO)

Parent: authentication

Applies whentype = oracleAppServerSSO

Direct Properties:

PropertyTypeRequiredDefault ValueDetails
namestringYesdata type=string; maxLen=255
Enter the name used by application developers to reference this authentication scheme.
typeenumYesdata type=string; lov=PLUGINS
Valid values: oracleAppServerSSO

Property Groups:

  • settings
  • source
  • sessionNotValid
  • loginProcessing
  • postLogout
  • sessionSharing
  • realAppSecurity
  • advanced
  • help
  • subscription
  • comments
settings
PropertyTypeRequiredDefault ValueDetails
partnerAppNamestringNodata type=string; maxLen=255
ssoServerLogoutUrlstringNodata type=string; maxLen=4000
settings {
  partnerAppName: value
  ssoServerLogoutUrl: value
}
source
PropertyTypeRequiredDefault ValueDetails
plsqlCodemultiline stringNodata type=multiline string; maxLen=32767

Enter a PL/SQL anonymous block of code that contains functions and procedures for verifying if the session is valid, pre- and post-authentication and (optionally) other authentication entry points.

For performance reasons, you can store this code in a PL/SQL package in the database.

source {
  plsqlCode: ```plsql
    value
  ```
}
sessionNotValid
PropertyTypeRequiredDefault ValueDetails
verifyFunctionNamestringNodata type=string; maxLen=255
redirectToenumYesloginPagedata type=string; lov=STATIC
Valid values: loginPage builtInLoginPage url
invalidSessionUrlcomplexNodata type=complex; maxLen=4000
Applies whenredirectTo = url
sessionNotValid {
  verifyFunctionName: value
  redirectTo: loginPage
  invalidSessionUrl: {
    type: in_app
    url: value
    app: value
    page: value
    items: [
      value
      value
    ]
    clearCache: value
    action: value
    request: value
    anchor: value
    session: "&SESSION."
    debug: "&DEBUG."
    printerFriendly: N
    otherArgs: value
  }
}
loginProcessing
PropertyTypeRequiredDefault ValueDetails
preAuthenticationProcedureNamestringNodata type=string; maxLen=255
postAuthenticationProcedureNamestringNodata type=string; maxLen=255
switchInSessionbooleanYesfalsedata type=boolean
loginProcessing {
  preAuthenticationProcedureName: value
  postAuthenticationProcedureName: value
  switchInSession: false
}
postLogout
PropertyTypeRequiredDefault ValueDetails
redirectToenumYeshomePagedata type=string; lov=STATIC
Valid values: homePage url
urlstringYesdata type=string; maxLen=4000
Applies whenredirectTo = url
postLogout {
  redirectTo: homePage
  url: value
}
sessionSharing
PropertyTypeRequiredDefault ValueDetails
typeenumYesappdata type=string; lov=STATIC
Valid values: app workspaceSharing custom
cookieNamestringNodata type=string; maxLen=255
Applies whentype = custom
cookiePathstringNodata type=string; maxLen=255
Applies whentype = custom
cookieDomainstringNodata type=string; maxLen=255
Applies whentype = custom
securebooleanYesfalsedata type=boolean
Applies whentype = custom
sessionSharing {
  type: app
  cookieName: value
  cookiePath: value
  cookieDomain: value
  secure: false
}
realAppSecurity
PropertyTypeRequiredDefault ValueDetails
rasModeenumYesdisableddata type=string; lov=STATIC
Valid values: disabled externalUsers internalUsers
dynamicRolesstringNodata type=string; maxLen=4000
Applies whenrasMode in (externalUsers)rasMode in (internalUsers)
namespacesstringNodata type=string; maxLen=4000
Applies whenrasMode in (externalUsers)rasMode in (internalUsers)
realAppSecurity {
  rasMode: disabled
  dynamicRoles: value
  namespaces: value
}
advanced
PropertyTypeRequiredDefault ValueDetails
staticIdstringYesdata type=string; maxLen=255
advanced {
  staticId: value
}
help
PropertyTypeRequiredDefault ValueDetails
helpTextmultiline stringNodata type=multiline string; maxLen=4000
Text displayed in a help popup window, available on the login page. This should offer guidance and links to resources to assist users of the Oracle APEX built-in login page, specific to the type of authentication your application is using (Open Door, Oracle APEX account, or LDAP).
help {
  helpText: ```html
    value
  ```
}
subscription
PropertyTypeRequiredDefault ValueDetails
masterenumNodata type=reference; lov=COMPONENT; references=authentication
Valid values: @/8842.261/builder-extension-sign-in @/8842.262/builder-extension-sign-in @/8842.9999/builder-extension-sign-in @/8842.9999/oracle-apex-accounts
subscription {
  master: "@/8842.261/builder-extension-sign-in"
}
comments
PropertyTypeRequiredDefault ValueDetails
commentsmultiline stringNodata type=multiline string; maxLen=4000
comments {
  comments: ```
    value
  ```
}

APEXlang Example

authentication sample (
    name: value
    type: oracleAppServerSSO
    settings {
        partnerAppName: value
        ssoServerLogoutUrl: value
    }
    source {
        plsqlCode: ```plsql
          value
        ```
    }
    sessionNotValid {
        verifyFunctionName: value
        redirectTo: loginPage
        invalidSessionUrl: {
          type: in_app
          url: value
          app: value
          page: value
          items: [
            value
            value
          ]
          clearCache: value
          action: value
          request: value
          anchor: value
          session: "&SESSION."
          debug: "&DEBUG."
          printerFriendly: N
          otherArgs: value
        }
    }
    loginProcessing {
        preAuthenticationProcedureName: value
        postAuthenticationProcedureName: value
        switchInSession: false
    }
    postLogout {
        redirectTo: homePage
        url: value
    }
    sessionSharing {
        type: app
        cookieName: value
        cookiePath: value
        cookieDomain: value
        secure: false
    }
    realAppSecurity {
        rasMode: disabled
        dynamicRoles: value
        namespaces: value
    }
    advanced {
        staticId: value
    }
    help {
        helpText: ```html
          value
        ```
    }
    subscription {
        master: "@/8842.261/builder-extension-sign-in"
    }
    comments {
        comments: ```
          value
        ```
    }
)