Frodo Library - v4.0.0-10
    Preparing search index...

    Module Reference

    Enumerations

    EnforcementGroup

    Interfaces

    AdminFederationExportInterface
    AgentExportInterface
    AgentGroupExportInterface
    AmConfigEntitiesInterface
    AmConfigEntityInterface
    ApplicationExportInterface
    AuthenticationSettingsExportInterface
    CirclesOfTrustExportInterface
    ConfigEntityExportInterface
    ConfigEntityExportInterface
    ConfigEntityExportOptions
    ConfigEntityImportOptions
    ConnectionProfileInterface
    ConnectionsFileInterface
    ConnectorExportInterface
    ConnectorExportOptions
    ConnectorImportOptions
    ConnectorServerStatusInterface
    CustomNodeExportInterface
    CustomNodeExportOptions
    CustomNodeImportOptions
    EmailTemplateExportInterface
    EnvInfoInterface
    ExportMetaData
    FeatureInterface
    FullExportInterface
    FullExportOptions
    FullGlobalExportInterface
    FullImportOptions
    FullRealmExportInterface
    FullService
    IdObjectSkeletonInterface
    InnerNodeRefSkeletonInterface
    InternalRoleExportInterface
    JwkInterface
    JwksInterface
    MappingExportInterface
    MappingExportOptions
    MappingImportOptions
    MultiTreeExportInterface
    NodeExportInterface
    NodeRefSkeletonInterface
    NoIdObjectSkeletonInterface
    OAuth2ClientExportInterface
    OAuth2ClientExportOptions
    OAuth2ClientImportOptions
    OAuth2TrustedJwtIssuerExportInterface
    OAuth2TrustedJwtIssuerExportOptions
    OAuth2TrustedJwtIssuerImportOptions
    PatchOperationInterface
    PlatformInfoInterface
    PolicyExportInterface
    PolicyExportOptions
    PolicyImportOptions
    PolicySetExportInterface
    PolicySetExportOptions
    PolicySetImportOptions
    RawExportOptions
    RealmExportInterface
    ResourceTypeExportInterface
    Saml2EntitiesExportOptions
    Saml2EntitiesImportOptions
    Saml2ExportInterface
    ScriptExportInterface
    ScriptExportOptions
    ScriptImportOptions
    ScriptTypeExportInterface
    SecretsExportInterface
    SecretStoreExportInterface
    SecureConnectionProfileInterface
    ServerExportInterface
    ServerExportOptions
    ServerImportOptions
    ServiceExportInterface
    ServiceImportOptions
    ServiceNextDescendent
    SingleTreeExportInterface
    SiteExportInterface
    SocialIdentityProviderExportOptions
    SocialIdentityProviderImportOptions
    SocialProviderExportInterface
    StateInterface
    SystemObjectPatchOperationInterface
    SystemStatusInterface
    ThemeExportInterface
    TokenCacheInterface
    TreeDependencyMapInterface
    TreeExportOptions
    TreeExportResolverInterface
    TreeImportOptions
    UiConfigInterface
    Updates
    UserExportInterface
    UserGroupExportInterface
    VariablesExportInterface

    Type Aliases

    AccessTokenMetaType
    AccessTokenResponseType
    Admin
    AdminFederation
    AdminFederationConfigSkeleton
    Agent
    AgentGroupSkeleton
    AgentSkeleton
    AgentType
    AllFlag
    AllowDuplicatesFlag
    AmConfig
    AmServiceSkeleton
    ApiFactory
    ApiVersion
    Application
    ApplicationExportOptions
    ApplicationImportOptions
    ApplicationSkeleton
    Authenticate
    AuthenticateSuccessResponse
    AuthenticationSettings
    AuthenticationSettingsSkeleton
    Base64
    Callback
    CallbackHandler
    CallbackKeyValuePair
    CallbackType
    CertificateResponse
    CircleOfTrustSkeleton
    CirclesOfTrust
    Config
    ConfigSkeleton
    ConnectionProfile
    Connector
    ConnectorSkeleton
    Constants
    ContentSecurityPolicy
    CookieDomains
    CSR
    CSRResponse
    CustomDomains
    CustomNodeProperty
    CustomNodeSkeleton
    CustomNodeUsage
    DeleteJourneysStatus
    DeleteJourneyStatus
    DirectiveEnabled
    DirectiveFlag
    DirectiveSource
    DirectiveSourceFlag
    EmailTemplate
    EmailTemplateSkeleton
    EngineConfigurationSkeleton
    EntityType
    EnvCertificate
    EnvContentSecurityPolicy
    EnvCookieDomains
    EnvCSR
    EnvCustomDomains
    EnvFederationEnforcement
    EnvironmentAndSystemPropertySecretStoreSkeleton
    EnvPromotion
    EnvRelease
    EnvServiceAccountScopes
    EnvSSOCookieConfig
    EsvCount
    EsvCountResponse
    ExportImport
    Feature
    FederationEnforcement
    FileSystemSecretStoreSkeleton
    Frodo
    FrodoCrypto
    FRUtils
    GatewayAgentType
    GoogleKeyManagementServiceSecretStoreSkeleton
    GoogleSecretManagerSecretStoreProviderSkeleton
    HsmSecretStoreSkeleton
    IdmConfig
    IdmConfigStub
    IdmCrypto
    IdmScript
    IdmSystem
    Idp
    Info
    InternalRole
    InternalRoleSkeleton
    JavaAgentType
    Jose
    Journey
    JourneyClassificationType
    Json
    JwkRsa
    JwkRsaPublic
    KeyStoreSecretStoreSkeleton
    LockResponse
    LockStatus
    Log
    LogApiKey
    LogEventPayloadSkeleton
    LogEventSkeleton
    ManagedObject
    Mapping
    MappingPolicy
    MappingProperty
    MappingSkeleton
    Node
    NodeClassificationType
    NodeSkeleton
    NoneFlag
    OAuth2Client
    OAuth2ClientSkeleton
    OAuth2Oidc
    OAuth2Provider
    OAuth2ProviderSkeleton
    OAuth2ThingType
    OAuth2TrustedJwtIssuer
    OAuth2TrustedJwtIssuerSkeleton
    ObjectPropertyFlag
    ObjectPropertyNativeType
    ObjectPropertySkeleton
    ObjectPropertyType
    ObjectTypeSkeleton
    Organization
    PagedResult
    PlatformInfo
    Policy
    PolicyAgentType
    PolicyCondition
    PolicyConditionType
    PolicySet
    PolicySetSkeleton
    PolicySkeleton
    ProgressIndicatorStatusType
    ProgressIndicatorType
    PromotionConfig
    PromotionConfigChange
    PromotionReport
    PromotionReportStub
    PromotionRequestConfig
    PromotionResponse
    PromotionStatus
    PromotionType
    RawConfig
    Readable
    Realm
    RealmSkeleton
    Recon
    ReconStatusType
    ReconType
    RefererDirectiveFlag
    Release
    RemoteConsentAgentType
    ResourceConfig
    ResourceType
    ResourceTypeSkeleton
    ResultCallback
    RetryEverythingStrategy
    RetryNetworkStrategy
    RetryNothingStrategy
    RetryStrategy
    RollbackConfig
    RollbackResponse
    Saml2
    Saml2ProiderLocation
    Saml2ProviderSkeleton
    Saml2ProviderStub
    SandboxDirectiveFlag
    Script
    ScriptContext
    ScriptFlag
    ScriptingContextSkeleton
    ScriptLanguage
    ScriptSkeleton
    ScriptType
    ScriptTypeExportSkeleton
    ScriptTypeSkeleton
    ScriptValidation
    Secret
    SecretEncodingType

    You can use the encoding parameter to set an encoding format when you create an ESV secret. You can only choose an encoding format using the API. The UI currently creates secrets only with the generic encoding format.

    SecretSkeleton
    SecretStore
    SecretStoreExportSkeleton
    SecretStoreMappingSkeleton
    SecretStoreSchemaSkeleton
    SecretStoreSkeleton
    SelfFlag
    Server
    ServerExportSkeleton
    ServerPropertiesSkeleton
    ServerSkeleton
    Service
    ServiceAccount
    ServiceAccountScope
    ServiceAccountType
    Session
    SessionInfoType
    SharedAgentType
    Site
    SiteSkeleton
    SoapSTSAgentType
    SocialIdpSkeleton
    SoftwarePublisherType
    SSOCookieConfig
    Startup
    State
    SyncSkeleton
    Theme
    ThemeSkeleton
    TokenCache
    TokenInfoResponseType
    Tokens
    tokenType
    TreeSkeleton
    User
    UserConfigSkeleton
    UserExportSkeleton
    UserGroupSkeleton
    UserSessionMetaType
    UserSkeleton
    Variable
    VariableExpressionType

    You can use the expressionType parameter to set a type when you create an ESV variable. This lets Identity Cloud correctly transform the value of the ESV to match the configuration property type when substituting it into configuration.

    The type is set when the ESV is created, and cannot be modified after creation. If you do not specify a type, it will default to string.

    Before the expressionType parameter was introduced, it was only possible to set types from within configuration, using expression level syntax; for example, {"$int": "&{esv.journey.ldap.port|1389}"}. The expressionType parameter supplements this expression level syntax and allows the ESV type to be identified without inspecting configuration.

    VariableSkeleton
    Version
    VersionOfSecretSkeleton
    VersionOfSecretStatus
    WebAgentType
    Writable