Latest update: 7.0.2
- Overview
- Amster Entity Reference
- AcceptTermsAndConditions
- AccountActiveCheck
- AccountActiveDecision
- AccountLockout
- ActiveDirectory
- ActiveDirectoryApplicationModeADAM
- ActiveDirectoryModule
- AdaptiveRiskModule
- AdvancedProperties
- AgentDataStoreDecision
- AgentGroups
- AgentService
- Agents
- AmsterModule
- AnonymousModule
- AnonymousSessionUpgrade
- AnonymousUserMapping
- ApplicationTypes
- Applications
- AttributeCollector
- AttributePresentDecision
- AttributeValueDecision
- AuditEvent
- AuditLogging
- AuthLevelDecision
- AuthTree
- AuthenticateThing
- Authentication
- AuthenticationChains
- AuthenticationModules
- AuthenticationNodes
- AuthenticationTreesConfiguration
- AuthenticatorOath
- AuthenticatorOathModule
- AuthenticatorPush
- AuthenticatorPushModule
- AuthenticatorPushRegistrationModule
- AuthenticatorWebAuthn
- BaseUrlSource
- CORSService
- CRESTReporter
- Captcha
- CertificateCollectorNode
- CertificateModule
- CertificateUserExtractorNode
- CertificateValidationNode
- ChoiceCollector
- CircleOfTrust
- CommonFederationConfiguration
- ConditionTypes
- ConfigurationVersionService
- ConsentCollector
- CookiePresenceDecisionNode
- CorsConfiguration
- CreateObject
- CreatePassword
- Csv
- CtsDataStoreProperties
- Dashboard
- DashboardInstance
- DashboardUserService
- Dashboards
- DataStoreDecision
- DataStoreInstance
- DataStoreModule
- DataStoreService
- DecisionCombiners
- DefaultAdvancedProperties
- DefaultCtsDataStoreProperties
- DefaultDirectoryConfiguration
- DefaultGeneralProperties
- DefaultSdkProperties
- DefaultSecurityProperties
- DefaultSessionProperties
- DefaultUmaDataStoreProperties
- DeviceGeofencing
- DeviceIDService
- DeviceIdMatchModule
- DeviceIdSaveModule
- DeviceLocationMatch
- DeviceMatch
- DeviceProfile
- DeviceProfileCollector
- DeviceProfileSave
- DeviceProfilesService
- DeviceTamperingVerification
- DirectoryConfiguration
- DisplayUsername
- ElasticSearch
- EmailService
- EmailSuspendNode
- EmailTemplateNode
- EnvironmentAndSystemPropertySecretsStore
- FailureURL
- FederationModule
- FileSystemSecretStore
- ForgeRockIAMDirectoryServer
- ForgottenPassword
- ForgottenUsername
- GeneralProperties
- GenericLDAPv3
- GetSessionData
- GlobalScripts
- GlobalSecretsSettings
- Globalization
- GoogleKeyManagementServiceSecretStore
- GoogleKmsMappings
- GraphiteReporter
- HOTPGenerator
- HostedSaml2EntityProvider
- HotpModule
- HsmMappings
- HsmSecretStore
- HttpBasicModule
- IDMProvisioning
- IdRepository
- IdRepositoryUser
- IdentifyExistingUser
- IdentityGatewayAgentGroups
- IdentityGatewayAgents
- IncrementLoginCount
- InnerTreeEvaluator
- IoTService
- J2EEAgentGroups
- J2eeAgents
- JSONStdout
- Jdbc
- JdbcModule
- Jms
- Json
- JwtProofOfPossessionModule
- KBADecision
- KBADefinition
- KBAVerification
- KbaQuestions
- KerberosNode
- KeyStoreMappings
- KeyStoreSecretStore
- LDAPDecision
- LdapModule
- LegacyUserSelfService
- LinkedInClient
- Logging
- LoginCountDecision
- MembershipModule
- MessageNode
- Meter
- ModifyAuthLevel
- Monitoring
- MsisdnModule
- MultiFederationProtocol
- Naming
- OAuth20
- OAuth2Client
- OAuth2ClientAgentGroups
- OAuth2Clients
- OAuth2Module
- OAuth2Provider
- OAuth2RemoteConsentAgentGroups
- OAuth2SoftwarePublisherAgentGroups
- OAuth2TrustedJWTIssuerAgentGroups
- OAuth2UserApplications
- OIDCClient
- OTPCollectorDecision
- OTPEmailSender
- OTPSMSSender
- OathModule
- OathUserDevices
- OpenDJ
- OpenIDConnect
- OpenIdConnectModule
- PageNode
- PasswordCollector
- PatchObject
- PendingUmaRequests
- PersistentCookieDecision
- PersistentCookieModule
- Platform
- PlatformPassword
- PlatformUsername
- Policies
- PolicyAgents
- PolicyConfiguration
- PollingWaitNode
- ProfileCompletenessDecision
- PrometheusReporter
- ProvisionDynamicAccount
- ProvisionIDMAccount
- PushNotification
- PushNotificationResponse
- PushResultVerifierNode
- PushSender
- PushUserDevices
- QueryFilterDecision
- RESTSecurityTokenServices
- RadiusClient
- RadiusModule
- RadiusServer
- Realms
- Records
- RecoveryCodeCollectorDecision
- RecoveryCodeDisplayNode
- RegisterLogoutWebhook
- RegisterThing
- RemoteConsentAgent
- RemoteConsentService
- RemoteSaml2EntityProvider
- RemoveSessionProperties
- RequiredAttributesPresent
- ResourceSets
- ResourceTypes
- RestApis
- RetryLimitDecision
- SAML2Authentication
- SOAPSecurityTokenServices
- SaeModule
- Saml2Entities
- Saml2Entity
- Saml2Module
- SamlV2ServiceConfiguration
- SamlV2SoapBinding
- ScriptStore
- ScriptTypes
- ScriptedDecision
- ScriptedModule
- Scripting
- ScriptingEngineConfiguration
- Scripts
- SdkProperties
- SecretStores
- Secrets
- SecurID
- SecurityProperties
- SecurityTokenServices
- SelectIdentityProvider
- SelfServiceTreeConfig
- SelfServiceTrees
- ServerInformation
- ServerVersion
- Servers
- Services
- Session
- SessionProperties
- SessionPropertyWhiteList
- SessionUserService
- Sessions
- SetPersistentCookie
- SetSessionProperties
- SharedAgents
- Sites
- SoapSTSAgentGroups
- SoapStsAgents
- SocialAuthInstagramModule
- SocialAuthOAuth2Module
- SocialAuthOpenIDModule
- SocialAuthTwitterModule
- SocialAuthVKontakteModule
- SocialAuthWeChatMobileModule
- SocialAuthWeChatModule
- SocialAuthentication
- SocialFacebook
- SocialGoogle
- SocialIdentityProviders
- SocialIdentityProvidersConfig
- SocialIgnoreProfile
- SocialProviderHandlerNode
- SoftwarePublisher
- Splunk
- StateMetadata
- SubjectAttributes
- SubjectTypes
- SuccessURL
- SunDSWithOpenAMSchema
- SupportedIds
- Syslog
- TermsAndConditionsDecision
- TimeSinceDecision
- TimerStart
- TimerStop
- TivoliDirectoryServer
- TransactionAuthentication
- TrustedJwtIssuer
- TrustedUserDevices
- TwitterClient
- UmaDataStoreProperties
- UmaPolicies
- UmaProvider
- UmaResourceSetLabels
- UmaUserAuditHistory
- User
- UserGroups
- UserPolicies
- UserRegistration
- UserSelfService
- UserServices
- UsernameCollector
- VKClient
- ValidationService
- WeChatClient
- WebAgentGroups
- WebAgents
- WebAuthnAuthenticationNode
- WebAuthnDeviceStorageNode
- WebAuthnRegistrationNode
- WebAuthnUserDevices
- WebhookService
- WindowsDesktopSsoModule
- WindowsNtModule
- WriteFederationInformation
- WsEntity
- ZeroPageLoginCollector
Monitoring
Global Operations
Resource path: /global-config/services/monitoring
Resource version: 1.0
getAllTypes
Obtain the collection of all secondary configuration types related to the resource.
Usage:
am> action Monitoring --global --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage:
am> action Monitoring --global --actionName getCreatableTypes
nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
Usage:
am> action Monitoring --global --actionName nextdescendents
read
Usage:
am> read Monitoring --global
update
Usage:
am> update Monitoring --global --body body
Parameters:
--body
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "snmpEnabled" : { "title" : "Monitoring SNMP interface status", "description" : "Enable / Disable the SNMP access to the monitoring system", "propertyOrder" : 800, "required" : true, "type" : "boolean", "exampleValue" : "" }, "policyHistoryWindowSize" : { "title" : "Policy evaluation monitoring history size", "description" : "Size of the window of most recent policy evaluations to record to expose via monitoring system. Valid range is 100 - 1000000.", "propertyOrder" : 900, "required" : true, "type" : "integer", "exampleValue" : "" }, "enabled" : { "title" : "Monitoring Status", "description" : "Enable / Disable the monitoring system", "propertyOrder" : 100, "required" : true, "type" : "boolean", "exampleValue" : "" }, "authfilePath" : { "title" : "Monitoring HTTP interface authentication file path", "description" : "Path to the monitoring system authentication file<br><br>The <code>openam_mon_auth</code> file contains the username and password of the account used to protect the monitoring interfaces. The default username is <code>demo</code> with a password of <code>changeit</code>. Use the <code>ampassword</code> command to encrypt a new password.", "propertyOrder" : 400, "required" : true, "type" : "string", "exampleValue" : "" }, "rmiEnabled" : { "title" : "Monitoring RMI interface status", "description" : "Enable / Disable the JMX access to the monitoring system", "propertyOrder" : 600, "required" : true, "type" : "boolean", "exampleValue" : "" }, "httpEnabled" : { "title" : "Monitoring HTTP interface status", "description" : "Enable / Disable the HTTP access to the monitoring system ", "propertyOrder" : 300, "required" : true, "type" : "boolean", "exampleValue" : "" }, "sessionHistoryWindowSize" : { "title" : "Session monitoring history size", "description" : "Size of the window of most recent session operations to record to expose via monitoring system. Valid range is 100 - 1000000.", "propertyOrder" : 1000, "required" : true, "type" : "integer", "exampleValue" : "" }, "snmpPort" : { "title" : "Monitoring SNMP Port", "description" : "Port number for the SNMP monitoring interface", "propertyOrder" : 700, "required" : true, "type" : "integer", "exampleValue" : "" }, "httpPort" : { "title" : "Monitoring HTTP Port", "description" : "Port number for the HTTP monitoring interface", "propertyOrder" : 200, "required" : true, "type" : "integer", "exampleValue" : "" }, "rmiPort" : { "title" : "Monitoring RMI Port", "description" : "Port number for the JMX monitoring interface", "propertyOrder" : 500, "required" : true, "type" : "integer", "exampleValue" : "" } } }