Amster

KeyStoreMappings

Realm Operations

Resource path:

/realm-config/secrets/stores/KeyStoreSecretStore/{KeyStoreSecretStore}/mappings

Resource version: 1.0

create

Usage

am> create KeyStoreMappings --realm Realm --KeyStoreSecretStore KeyStoreSecretStore --id id --body body

Parameters

--KeyStoreSecretStore
--id

The unique identifier for the resource.

--body

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

{
  "type" : "object",
  "properties" : {
    "secretId" : {
      "title" : "Secret ID",
      "description" : "The secret ID that is to be associated with an alias.",
      "propertyOrder" : 100,
      "required" : true,
      "type" : "string",
      "exampleValue" : ""
    },
    "aliases" : {
      "title" : "Aliases",
      "description" : "The list of keystore aliases that can resolve the secret. The first element of the alias list determines which alias is the \"active\" one. Active secrets are used for signature generation and encryption, while the non-active secrets are mainly used for signature verification and decryption.",
      "propertyOrder" : 200,
      "required" : true,
      "items" : {
        "type" : "string",
        "minLength" : 1
      },
      "minItems" : 1,
      "uniqueItems" : true,
      "type" : "array",
      "exampleValue" : ""
    }
  }
}

delete

Usage

am> delete KeyStoreMappings --realm Realm --KeyStoreSecretStore KeyStoreSecretStore --id id

Parameters

--KeyStoreSecretStore
--id

The unique identifier for the resource.

getAllTypes

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

Usage

am> action KeyStoreMappings --realm Realm --KeyStoreSecretStore KeyStoreSecretStore --actionName getAllTypes

Parameters

--KeyStoreSecretStore

=== getCreatableTypes

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

Usage

am> action KeyStoreMappings --realm Realm --KeyStoreSecretStore KeyStoreSecretStore --actionName getCreatableTypes

Parameters

--KeyStoreSecretStore

=== nextdescendents

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

Usage

am> action KeyStoreMappings --realm Realm --KeyStoreSecretStore KeyStoreSecretStore --actionName nextdescendents

Parameters

--KeyStoreSecretStore

=== query

Get the full list of instances of this collection. This query only supports _queryFilter=true filter.

Usage

am> query KeyStoreMappings --realm Realm --KeyStoreSecretStore KeyStoreSecretStore --filter filter

Parameters

--KeyStoreSecretStore
--filter

A CREST formatted query filter, where "true" will query all.

read

Usage

am> read KeyStoreMappings --realm Realm --KeyStoreSecretStore KeyStoreSecretStore --id id

Parameters

--KeyStoreSecretStore
--id

The unique identifier for the resource.

update

Usage

am> update KeyStoreMappings --realm Realm --KeyStoreSecretStore KeyStoreSecretStore --id id --body body

Parameters

--KeyStoreSecretStore
--id

The unique identifier for the resource.

--body

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

{
  "type" : "object",
  "properties" : {
    "secretId" : {
      "title" : "Secret ID",
      "description" : "The secret ID that is to be associated with an alias.",
      "propertyOrder" : 100,
      "required" : true,
      "type" : "string",
      "exampleValue" : ""
    },
    "aliases" : {
      "title" : "Aliases",
      "description" : "The list of keystore aliases that can resolve the secret. The first element of the alias list determines which alias is the \"active\" one. Active secrets are used for signature generation and encryption, while the non-active secrets are mainly used for signature verification and decryption.",
      "propertyOrder" : 200,
      "required" : true,
      "items" : {
        "type" : "string",
        "minLength" : 1
      },
      "minItems" : 1,
      "uniqueItems" : true,
      "type" : "array",
      "exampleValue" : ""
    }
  }
}

Global Operations

Resource path:

/global-config/secrets/stores/KeyStoreSecretStore/{KeyStoreSecretStore}/mappings

Resource version: 1.0

create

Usage

am> create KeyStoreMappings --global --KeyStoreSecretStore KeyStoreSecretStore --id id --body body

Parameters

--KeyStoreSecretStore
--id

The unique identifier for the resource.

--body

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

{
  "type" : "object",
  "properties" : {
    "secretId" : {
      "title" : "Secret ID",
      "description" : "The secret ID that is to be associated with an alias.",
      "propertyOrder" : 100,
      "required" : true,
      "type" : "string",
      "exampleValue" : ""
    },
    "aliases" : {
      "title" : "Aliases",
      "description" : "The list of keystore aliases that can resolve the secret. The first element of the alias list determines which alias is the \"active\" one. Active secrets are used for signature generation and encryption, while the non-active secrets are mainly used for signature verification and decryption.",
      "propertyOrder" : 200,
      "required" : true,
      "items" : {
        "type" : "string",
        "minLength" : 1
      },
      "minItems" : 1,
      "uniqueItems" : true,
      "type" : "array",
      "exampleValue" : ""
    }
  }
}

delete

Usage

am> delete KeyStoreMappings --global --KeyStoreSecretStore KeyStoreSecretStore --id id

Parameters

--KeyStoreSecretStore
--id

The unique identifier for the resource.

getAllTypes

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

Usage

am> action KeyStoreMappings --global --KeyStoreSecretStore KeyStoreSecretStore --actionName getAllTypes

Parameters

--KeyStoreSecretStore

=== getCreatableTypes

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

Usage

am> action KeyStoreMappings --global --KeyStoreSecretStore KeyStoreSecretStore --actionName getCreatableTypes

Parameters

--KeyStoreSecretStore

=== nextdescendents

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

Usage

am> action KeyStoreMappings --global --KeyStoreSecretStore KeyStoreSecretStore --actionName nextdescendents

Parameters

--KeyStoreSecretStore

=== query

Get the full list of instances of this collection. This query only supports _queryFilter=true filter.

Usage

am> query KeyStoreMappings --global --KeyStoreSecretStore KeyStoreSecretStore --filter filter

Parameters

--KeyStoreSecretStore
--filter

A CREST formatted query filter, where "true" will query all.

read

Usage

am> read KeyStoreMappings --global --KeyStoreSecretStore KeyStoreSecretStore --id id

Parameters

--KeyStoreSecretStore
--id

The unique identifier for the resource.

update

Usage

am> update KeyStoreMappings --global --KeyStoreSecretStore KeyStoreSecretStore --id id --body body

Parameters

--KeyStoreSecretStore
--id

The unique identifier for the resource.

--body

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

{
  "type" : "object",
  "properties" : {
    "secretId" : {
      "title" : "Secret ID",
      "description" : "The secret ID that is to be associated with an alias.",
      "propertyOrder" : 100,
      "required" : true,
      "type" : "string",
      "exampleValue" : ""
    },
    "aliases" : {
      "title" : "Aliases",
      "description" : "The list of keystore aliases that can resolve the secret. The first element of the alias list determines which alias is the \"active\" one. Active secrets are used for signature generation and encryption, while the non-active secrets are mainly used for signature verification and decryption.",
      "propertyOrder" : 200,
      "required" : true,
      "items" : {
        "type" : "string",
        "minLength" : 1
      },
      "minItems" : 1,
      "uniqueItems" : true,
      "type" : "array",
      "exampleValue" : ""
    }
  }
}
Copyright © 2010-2023 ForgeRock, all rights reserved.