LoginCountDecision

Realm Operations

Resource path:

/realm-config/authentication/authenticationtrees/nodes/LoginCountDecisionNode

Resource version: 1.0

create

Usage

am> create LoginCountDecision --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" : {
    "interval" : {
      "title" : "Interval",
      "description" : "The interval type for which the decision should occur. Valid types are 'every' and 'at'.",
      "propertyOrder" : 100,
      "type" : "string",
      "exampleValue" : ""
    },
    "amount" : {
      "title" : "Amount",
      "description" : "The amount (count) of logins for the interval.",
      "propertyOrder" : 200,
      "type" : "integer",
      "exampleValue" : ""
    },
    "identityAttribute" : {
      "title" : "Identity Attribute",
      "description" : "The attribute of the IDM object to use retrieve the object.",
      "propertyOrder" : 300,
      "type" : "string",
      "exampleValue" : ""
    }
  },
  "required" : [ "amount", "interval", "identityAttribute" ]
}

delete

Usage

am> delete LoginCountDecision --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 LoginCountDecision --realm Realm --actionName getAllTypes

getCreatableTypes

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

Usage

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

listOutcomes

List the available outcomes for the node type.

Usage

am> action LoginCountDecision --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 LoginCountDecision --realm Realm --actionName nextdescendents

query

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

Usage

am> query LoginCountDecision --realm Realm --filter filter

Parameters

--filter

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

read

Usage

am> read LoginCountDecision --realm Realm --id id

Parameters

--id

The unique identifier for the resource.

update

Usage

am> update LoginCountDecision --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" : {
    "interval" : {
      "title" : "Interval",
      "description" : "The interval type for which the decision should occur. Valid types are 'every' and 'at'.",
      "propertyOrder" : 100,
      "type" : "string",
      "exampleValue" : ""
    },
    "amount" : {
      "title" : "Amount",
      "description" : "The amount (count) of logins for the interval.",
      "propertyOrder" : 200,
      "type" : "integer",
      "exampleValue" : ""
    },
    "identityAttribute" : {
      "title" : "Identity Attribute",
      "description" : "The attribute of the IDM object to use retrieve the object.",
      "propertyOrder" : 300,
      "type" : "string",
      "exampleValue" : ""
    }
  },
  "required" : [ "amount", "interval", "identityAttribute" ]
}