IDMProvisioning

Global Operations

Resource path:

/global-config/services/idm-integration

Resource version: 1.0

getAllTypes

Obtain the collection of all secondary configuration types related to the resource.

Usage

am> action IDMProvisioning --global --actionName getAllTypes

getCreatableTypes

Obtain the collection of secondary configuration types that have yet to be added to the resource.

Usage

am> action IDMProvisioning --global --actionName getCreatableTypes

nextdescendents

Obtain the collection of secondary configuration instances that have been added to the resource.

Usage

am> action IDMProvisioning --global --actionName nextdescendents

read

Usage

am> read IDMProvisioning --global

update

Usage

am> update IDMProvisioning --global --body body

Parameters

--body

The resource in JSON format, described by the following JSON schema:

{
  "type" : "object",
  "properties" : {
    "jwtSigningCompatibilityMode" : {
      "title" : "Signing Compatibility Mode",
      "description" : "Enable OpenAM to communicate with OpenIDM 6 and earlier.<br><br>When this option is enabled, OpenAM will sign JWTs in a way that is compatible with versions of OpenIDM 6 and earlier.  The approach used is incompatible with non-extractable HSM keys.  Disable this option if you have upgraded to OpenIDM 6.5, or later.",
      "propertyOrder" : 800,
      "required" : true,
      "type" : "boolean",
      "exampleValue" : ""
    },
    "provisioningEncryptionMethod" : {
      "title" : "Encryption Method",
      "description" : "JWT encryption method.",
      "propertyOrder" : 1000,
      "required" : true,
      "type" : "string",
      "exampleValue" : ""
    },
    "provisioningEncryptionKeyAlias" : {
      "title" : "Encryption Key Alias",
      "description" : "Alias of the encryption asymmetric key in AM's default keystore. Must be a duplicate of the asymmetric key used by IDM.",
      "propertyOrder" : 600,
      "required" : true,
      "type" : "string",
      "exampleValue" : ""
    },
    "idmProvisioningClient" : {
      "title" : "IDM Provisioning Client",
      "description" : "The name of the oauth client to be used for the client credentials flow",
      "propertyOrder" : 400,
      "required" : true,
      "type" : "string",
      "exampleValue" : ""
    },
    "idmDeploymentPath" : {
      "title" : "Deployment Path",
      "description" : "Path of the IDM deployment, e.g. openidm",
      "propertyOrder" : 300,
      "required" : true,
      "type" : "string",
      "exampleValue" : ""
    },
    "provisioningSigningKeyAlias" : {
      "title" : "Signing Key Alias",
      "description" : "Alias of the signing symmetric key in AM's default keystore. Must be a duplicate of the symmetric key used by IDM.",
      "propertyOrder" : 500,
      "required" : true,
      "type" : "string",
      "exampleValue" : ""
    },
    "provisioningEncryptionAlgorithm" : {
      "title" : "Encryption Algorithm",
      "description" : "JWT encryption algorithm.",
      "propertyOrder" : 900,
      "required" : true,
      "type" : "string",
      "exampleValue" : ""
    },
    "provisioningSigningAlgorithm" : {
      "title" : "Signing Algorithm",
      "description" : "JWT signing algorithm.",
      "propertyOrder" : 700,
      "required" : true,
      "type" : "string",
      "exampleValue" : ""
    },
    "idmDeploymentUrl" : {
      "title" : "Deployment URL",
      "description" : "URL of the IDM deployment, e.g. https://localhost:8080",
      "propertyOrder" : 200,
      "required" : true,
      "type" : "string",
      "exampleValue" : ""
    },
    "enabled" : {
      "title" : "Enabled",
      "description" : "",
      "propertyOrder" : 100,
      "required" : true,
      "type" : "boolean",
      "exampleValue" : ""
    }
  }
}