SetFailureDetails
Realm Operations
Resource path:
/realm-config/authentication/authenticationtrees/nodes/SetFailureDetailsNode/1.0
Resource version: 3.0
create
Usage
am> create SetFailureDetails --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" : { "headerControl" : { "title" : "Response Headers", "description" : "The headers to set on the response when authentication fails.", "propertyOrder" : 300, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "failureDetails" : { "title" : "Failure Details", "description" : "The details to add to the response body when the authentication fails", "propertyOrder" : 200, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "failureMessage" : { "title" : "Failure Message", "description" : "The localizable message to add to the response body when the authentication fails", "propertyOrder" : 100, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" } }, "required" : [ "headerControl", "failureDetails", "failureMessage" ] }
delete
Usage
am> delete SetFailureDetails --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
getType
List information related to the node such as a name, description, tags and metadata.
Usage
am> action SetFailureDetails --realm Realm --actionName getType
getUpgradedConfig
Get the upgraded configuration for the node type.
Usage
am> action SetFailureDetails --realm Realm --body body --actionName getUpgradedConfig --targetVersion targetVersion
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "title" : "The current configuration of the node type." } - --targetVersion
-
=== listOutcomes
List the available outcomes for the node type.
Usage
am> action SetFailureDetails --realm Realm --body body --actionName listOutcomes
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "description" : "Some configuration of the node. This does not need to be complete against the configuration schema.", "type" : "object", "title" : "Node configuration" }
query
Get the full list of instances of this collection. This query only supports _queryFilter=true filter.
Usage
am> query SetFailureDetails --realm Realm --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
read
Usage
am> read SetFailureDetails --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
update
Usage
am> update SetFailureDetails --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" : { "headerControl" : { "title" : "Response Headers", "description" : "The headers to set on the response when authentication fails.", "propertyOrder" : 300, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "failureDetails" : { "title" : "Failure Details", "description" : "The details to add to the response body when the authentication fails", "propertyOrder" : 200, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "failureMessage" : { "title" : "Failure Message", "description" : "The localizable message to add to the response body when the authentication fails", "propertyOrder" : 100, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" } }, "required" : [ "headerControl", "failureDetails", "failureMessage" ] }