--- title: RSASecurID description: Resource path: component: pingam version: 8.1 page_id: pingam:entity-reference:sec-amster-entity-rsasecurid canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-rsasecurid.html section_ids: sec-amster-entity-rsasecurid-realm-ops: Realm Operations sec-amster-entity-rsasecurid-realm-ops-create: create sec-amster-entity-rsasecurid-realm-ops-delete: delete sec-amster-entity-rsasecurid-realm-ops-gettype: getType sec-amster-entity-rsasecurid-realm-ops-getupgradedconfig: getUpgradedConfig sec-amster-entity-rsasecurid-realm-ops-query: query sec-amster-entity-rsasecurid-realm-ops-read: read sec-amster-entity-rsasecurid-realm-ops-update: update sec-amster-entity-rsasecurid-realm-ops-versioninfo: versionInfo --- # RSASecurID ## Realm Operations Resource path: ``` /realm-config/authentication/authenticationtrees/nodes/product-SecurIdNode/1.0 ``` Resource version: `3.0` ### create **Usage** ``` am> create RSASecurID --realm Realm --id id --body body ``` **Parameters** * *\--id* The unique identifier for the resource. * *\--body* The resource in JSON format, described by the following JSON schema: ```json { "type" : "object", "properties" : { "authnAttemptTimeout" : { "title" : "Authentication Attempt Timeout", "description" : "The number of seconds before RSA SecurID times out the authentication request. Applies only to the Cloud Authentication Service.", "propertyOrder" : 500, "type" : "integer", "exampleValue" : "" }, "baseUrl" : { "title" : "SecurID URL", "description" : "The URL for an instance of RSA Authentication Manager or the RSA Cloud Authentication Service.", "propertyOrder" : 100, "type" : "string", "exampleValue" : "" }, "assurancePolicy" : { "title" : "Assurance Policy", "description" : "The name of the assurance policy to be used by RSA SecurID. Applies only to the Cloud Authentication Service.", "propertyOrder" : 300, "type" : "string", "exampleValue" : "" }, "clientId" : { "title" : "Client ID", "description" : "The string RSA uses to determine principal identity and access control. Optional for the Cloud Authentication Service, required for Authentication Manager.", "propertyOrder" : 200, "type" : "string", "exampleValue" : "" }, "waitingMessage" : { "title" : "Waiting Message", "description" : "Localization overrides for the message displayed to the user to respond to a push notification. Key-value map of language to localized message. The value defaults to \"Waiting for your response\" if no overrides are provided.", "propertyOrder" : 800, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "mfaChoicePrompt" : { "title" : "Prompt for MFA Choice", "description" : "Localization overrides for the message displayed to the user when requesting an MFA method. Key-value map of language to localized message. The value defaults to \"Select your preferred MFA method\" if no overrides are provided.", "propertyOrder" : 700, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "httpClient" : { "title" : "HTTP Client", "description" : "The HTTP Client to use for communication with the RSA API. If you don't have a custom HTTP Client, leave this blank to use the default HTTP Client.", "propertyOrder" : 600, "type" : "string", "exampleValue" : "" }, "clientKeySecretLabelIdentifier" : { "title" : "Client Key Secret Label Identifier", "description" : "The identifier for the unique key for communication between AM and the RSA API.", "propertyOrder" : 400, "type" : "string", "exampleValue" : "" } }, "required" : [ "authnAttemptTimeout", "baseUrl", "waitingMessage", "mfaChoicePrompt", "httpClient", "clientKeySecretLabelIdentifier" ] } ``` ### delete **Usage** ``` am> delete RSASecurID --realm Realm --id id ``` **Parameters** * *\--id* The unique identifier for the resource. ### getType List information related to the node such as a name, description, tags and metadata. **Usage** ``` am> action RSASecurID --realm Realm --actionName getType ``` ### getUpgradedConfig Get the upgraded configuration for the node type. **Usage** ``` am> action RSASecurID --realm Realm --body body --actionName getUpgradedConfig --targetVersion targetVersion ``` **Parameters** * *\--body* The resource in JSON format, described by the following JSON schema: ```json { "type" : "object", "title" : "The current configuration of the node type." } ``` * *\--targetVersion* \=== listOutcomes List the available outcomes for the node type. **Usage** ``` am> action RSASecurID --realm Realm --body body --actionName listOutcomes ``` **Parameters** * *\--body* The resource in JSON format, described by the following JSON schema: ```json { "description" : "Some configuration of the node. This does not need to be complete against the configuration schema.", "type" : "object", "title" : "Node configuration" } ``` ### query Get the full list of instances of this collection. This query only supports `_queryFilter=true` filter. **Usage** ``` am> query RSASecurID --realm Realm --filter filter ``` **Parameters** * *\--filter* A CREST formatted query filter, where "true" will query all. ### read **Usage** ``` am> read RSASecurID --realm Realm --id id ``` **Parameters** * *\--id* The unique identifier for the resource. ### update **Usage** ``` am> update RSASecurID --realm Realm --id id --body body ``` **Parameters** * *\--id* The unique identifier for the resource. * *\--body* The resource in JSON format, described by the following JSON schema: ```json { "type" : "object", "properties" : { "authnAttemptTimeout" : { "title" : "Authentication Attempt Timeout", "description" : "The number of seconds before RSA SecurID times out the authentication request. Applies only to the Cloud Authentication Service.", "propertyOrder" : 500, "type" : "integer", "exampleValue" : "" }, "baseUrl" : { "title" : "SecurID URL", "description" : "The URL for an instance of RSA Authentication Manager or the RSA Cloud Authentication Service.", "propertyOrder" : 100, "type" : "string", "exampleValue" : "" }, "assurancePolicy" : { "title" : "Assurance Policy", "description" : "The name of the assurance policy to be used by RSA SecurID. Applies only to the Cloud Authentication Service.", "propertyOrder" : 300, "type" : "string", "exampleValue" : "" }, "clientId" : { "title" : "Client ID", "description" : "The string RSA uses to determine principal identity and access control. Optional for the Cloud Authentication Service, required for Authentication Manager.", "propertyOrder" : 200, "type" : "string", "exampleValue" : "" }, "waitingMessage" : { "title" : "Waiting Message", "description" : "Localization overrides for the message displayed to the user to respond to a push notification. Key-value map of language to localized message. The value defaults to \"Waiting for your response\" if no overrides are provided.", "propertyOrder" : 800, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "mfaChoicePrompt" : { "title" : "Prompt for MFA Choice", "description" : "Localization overrides for the message displayed to the user when requesting an MFA method. Key-value map of language to localized message. The value defaults to \"Select your preferred MFA method\" if no overrides are provided.", "propertyOrder" : 700, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "httpClient" : { "title" : "HTTP Client", "description" : "The HTTP Client to use for communication with the RSA API. If you don't have a custom HTTP Client, leave this blank to use the default HTTP Client.", "propertyOrder" : 600, "type" : "string", "exampleValue" : "" }, "clientKeySecretLabelIdentifier" : { "title" : "Client Key Secret Label Identifier", "description" : "The identifier for the unique key for communication between AM and the RSA API.", "propertyOrder" : 400, "type" : "string", "exampleValue" : "" } }, "required" : [ "authnAttemptTimeout", "baseUrl", "waitingMessage", "mfaChoicePrompt", "httpClient", "clientKeySecretLabelIdentifier" ] } ``` ### versionInfo List the versions available for the node type. **Usage** ``` am> action RSASecurID --realm Realm --actionName versionInfo ```