Amster

DataStoreService

Realm Operations

Resource path:

/realm-config/services/DataStoreService

Resource version: 2.0

create

Usage

am> create DataStoreService --realm Realm --body body

Parameters

--body

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

{
  "type" : "object",
  "properties" : {
    "applicationDataStoreId" : {
      "title" : "Application Data Store",
      "description" : "Select a data store configuration to be used for application storage",
      "propertyOrder" : 200,
      "required" : true,
      "type" : "string",
      "exampleValue" : ""
    },
    "policyDataStoreId" : {
      "title" : "Policy Data Store",
      "description" : "Select a data store configuration to be used for policy storage",
      "propertyOrder" : 100,
      "required" : true,
      "type" : "string",
      "exampleValue" : ""
    }
  }
}

delete

Usage

am> delete DataStoreService --realm Realm

getAllTypes

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

Usage

am> action DataStoreService --realm Realm --actionName getAllTypes

getCreatableTypes

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

Usage

am> action DataStoreService --realm Realm --actionName getCreatableTypes

nextdescendents

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

Usage

am> action DataStoreService --realm Realm --actionName nextdescendents

read

Usage

am> read DataStoreService --realm Realm

update

Usage

am> update DataStoreService --realm Realm --body body

Parameters

--body

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

{
  "type" : "object",
  "properties" : {
    "applicationDataStoreId" : {
      "title" : "Application Data Store",
      "description" : "Select a data store configuration to be used for application storage",
      "propertyOrder" : 200,
      "required" : true,
      "type" : "string",
      "exampleValue" : ""
    },
    "policyDataStoreId" : {
      "title" : "Policy Data Store",
      "description" : "Select a data store configuration to be used for policy storage",
      "propertyOrder" : 100,
      "required" : true,
      "type" : "string",
      "exampleValue" : ""
    }
  }
}

Global Operations

Resource path:

/global-config/services/DataStoreService

Resource version: 1.0

getAllTypes

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

Usage

am> action DataStoreService --global --actionName getAllTypes

getCreatableTypes

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

Usage

am> action DataStoreService --global --actionName getCreatableTypes

nextdescendents

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

Usage

am> action DataStoreService --global --actionName nextdescendents

read

Usage

am> read DataStoreService --global

update

Usage

am> update DataStoreService --global --body body

Parameters

--body

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

{
  "type" : "object",
  "properties" : {
    "defaults" : {
      "properties" : {
        "policyDataStoreId" : {
          "title" : "Policy Data Store",
          "description" : "Select a data store configuration to be used for policy storage",
          "propertyOrder" : 100,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        },
        "applicationDataStoreId" : {
          "title" : "Application Data Store",
          "description" : "Select a data store configuration to be used for application storage",
          "propertyOrder" : 200,
          "required" : true,
          "type" : "string",
          "exampleValue" : ""
        }
      },
      "type" : "object",
      "title" : "Realm Defaults"
    }
  }
}
Copyright © 2010-2024 ForgeRock, all rights reserved.