HsmMappings
Realm Operations
Resource path:
/realm-config/secrets/stores/HsmSecretStore/{HsmSecretStore}/mappings
Resource version: 2.0
create
Usage
am> create HsmMappings --realm Realm --HsmSecretStore HsmSecretStore --id id --body body
Parameters
- --HsmSecretStore
- --id
-
The unique identifier for the resource.
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "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" : "" }, "secretId" : { "title" : "Secret Label", "description" : "The secret label that is to be associated with an alias.", "propertyOrder" : 100, "required" : true, "type" : "string", "exampleValue" : "" } } }
delete
Usage
am> delete HsmMappings --realm Realm --HsmSecretStore HsmSecretStore --id id
Parameters
- --HsmSecretStore
- --id
-
The unique identifier for the resource.
getAllTypes
Obtain the collection of all secondary configuration types related to the resource.
Usage
am> action HsmMappings --realm Realm --HsmSecretStore HsmSecretStore --actionName getAllTypes
Parameters
- --HsmSecretStore
-
=== getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action HsmMappings --realm Realm --HsmSecretStore HsmSecretStore --actionName getCreatableTypes
Parameters
- --HsmSecretStore
-
=== nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
Usage
am> action HsmMappings --realm Realm --HsmSecretStore HsmSecretStore --actionName nextdescendents
Parameters
- --HsmSecretStore
-
=== query
Get the full list of instances of this collection. This query only supports _queryFilter=true filter.
Usage
am> query HsmMappings --realm Realm --filter filter --HsmSecretStore HsmSecretStore
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
- --HsmSecretStore
-
=== read
Usage
am> read HsmMappings --realm Realm --HsmSecretStore HsmSecretStore --id id
Parameters
- --HsmSecretStore
- --id
-
The unique identifier for the resource.
update
Usage
am> update HsmMappings --realm Realm --HsmSecretStore HsmSecretStore --id id --body body
Parameters
- --HsmSecretStore
- --id
-
The unique identifier for the resource.
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "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" : "" }, "secretId" : { "title" : "Secret Label", "description" : "The secret label that is to be associated with an alias.", "propertyOrder" : 100, "required" : true, "type" : "string", "exampleValue" : "" } } }
Global Operations
Resource path:
/global-config/secrets/stores/HsmSecretStore/{HsmSecretStore}/mappings
Resource version: 1.0
create
Usage
am> create HsmMappings --global --HsmSecretStore HsmSecretStore --id id --body body
Parameters
- --HsmSecretStore
- --id
-
The unique identifier for the resource.
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "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" : "" }, "secretId" : { "title" : "Secret Label", "description" : "The secret label that is to be associated with an alias.", "propertyOrder" : 100, "required" : true, "type" : "string", "exampleValue" : "" } } }
delete
Usage
am> delete HsmMappings --global --HsmSecretStore HsmSecretStore --id id
Parameters
- --HsmSecretStore
- --id
-
The unique identifier for the resource.
getAllTypes
Obtain the collection of all secondary configuration types related to the resource.
Usage
am> action HsmMappings --global --HsmSecretStore HsmSecretStore --actionName getAllTypes
Parameters
- --HsmSecretStore
-
=== getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action HsmMappings --global --HsmSecretStore HsmSecretStore --actionName getCreatableTypes
Parameters
- --HsmSecretStore
-
=== nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
Usage
am> action HsmMappings --global --HsmSecretStore HsmSecretStore --actionName nextdescendents
Parameters
- --HsmSecretStore
-
=== query
Get the full list of instances of this collection. This query only supports _queryFilter=true filter.
Usage
am> query HsmMappings --global --filter filter --HsmSecretStore HsmSecretStore
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
- --HsmSecretStore
-
=== read
Usage
am> read HsmMappings --global --HsmSecretStore HsmSecretStore --id id
Parameters
- --HsmSecretStore
- --id
-
The unique identifier for the resource.
update
Usage
am> update HsmMappings --global --HsmSecretStore HsmSecretStore --id id --body body
Parameters
- --HsmSecretStore
- --id
-
The unique identifier for the resource.
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "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" : "" }, "secretId" : { "title" : "Secret Label", "description" : "The secret label that is to be associated with an alias.", "propertyOrder" : 100, "required" : true, "type" : "string", "exampleValue" : "" } } }