Amster

AttributeCollector

Realm Operations

Resource path:

/realm-config/authentication/authenticationtrees/nodes/AttributeCollectorNode

Resource version: 1.0

create

Usage

am> create AttributeCollector --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:

{
  "type" : "object",
  "properties" : {
    "validateInputs" : {
      "title" : "Validate Input",
      "description" : "Set to true if client input should be validated against IDM policy as declared in the schema.",
      "propertyOrder" : 300,
      "type" : "boolean",
      "exampleValue" : ""
    },
    "identityAttribute" : {
      "title" : "Identity Attribute",
      "description" : "The attribute used to identify the the object in IDM.",
      "propertyOrder" : 400,
      "type" : "string",
      "exampleValue" : ""
    },
    "required" : {
      "title" : "All Attributes Required",
      "description" : "When set, requires all attributes collected to contain non-null values.",
      "propertyOrder" : 200,
      "type" : "boolean",
      "exampleValue" : ""
    },
    "attributesToCollect" : {
      "title" : "Attributes to Collect",
      "description" : "A set of attributes to collect from the client.",
      "propertyOrder" : 100,
      "items" : {
        "type" : "string"
      },
      "minItems" : 1,
      "type" : "array",
      "exampleValue" : ""
    }
  },
  "required" : [ "validateInputs", "attributesToCollect", "identityAttribute", "required" ]
}

delete

Usage

am> delete AttributeCollector --realm Realm --id id

Parameters

--id

The unique identifier for the resource.

getAllTypes

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

Usage

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

getCreatableTypes

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

Usage

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

listOutcomes

List the available outcomes for the node type.

Usage

am> action AttributeCollector --realm Realm --body body --actionName listOutcomes

Parameters

--body

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

{
  "type" : "object",
  "title" : "Some configuration of the node. This does not need to be complete against the configuration schema."
}

nextdescendents

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

Usage

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

query

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

Usage

am> query AttributeCollector --realm Realm --filter filter

Parameters

--filter

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

read

Usage

am> read AttributeCollector --realm Realm --id id

Parameters

--id

The unique identifier for the resource.

update

Usage

am> update AttributeCollector --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:

{
  "type" : "object",
  "properties" : {
    "validateInputs" : {
      "title" : "Validate Input",
      "description" : "Set to true if client input should be validated against IDM policy as declared in the schema.",
      "propertyOrder" : 300,
      "type" : "boolean",
      "exampleValue" : ""
    },
    "identityAttribute" : {
      "title" : "Identity Attribute",
      "description" : "The attribute used to identify the the object in IDM.",
      "propertyOrder" : 400,
      "type" : "string",
      "exampleValue" : ""
    },
    "required" : {
      "title" : "All Attributes Required",
      "description" : "When set, requires all attributes collected to contain non-null values.",
      "propertyOrder" : 200,
      "type" : "boolean",
      "exampleValue" : ""
    },
    "attributesToCollect" : {
      "title" : "Attributes to Collect",
      "description" : "A set of attributes to collect from the client.",
      "propertyOrder" : 100,
      "items" : {
        "type" : "string"
      },
      "minItems" : 1,
      "type" : "array",
      "exampleValue" : ""
    }
  },
  "required" : [ "validateInputs", "attributesToCollect", "identityAttribute", "required" ]
}
Copyright © 2010-2023 ForgeRock, all rights reserved.