AuthenticationChains
Realm Operations
Resource path:
/realm-config/authentication/chains
Resource version: 1.0
create
Usage
am> create AuthenticationChains --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" : { "loginFailureUrl" : { "title" : "Login Failed URL", "description" : "URL or ClientType|URL if client specific. URL without http(s) protocol will be appended to the current URI.", "propertyOrder" : 300, "required" : true, "items" : { "type" : "string" }, "type" : "array", "exampleValue" : "" }, "authChainConfiguration" : { "title" : "Authentication Configuration", "description" : "", "propertyOrder" : 100, "required" : true, "exampleValue" : "", "type" : "array", "items" : { "type" : "object", "properties" : { "module" : { "type" : "string" }, "criteria" : { "type" : "string" }, "options" : { "type" : "object", "patternProperties" : { ".*" : { "type" : "string" } } } } } }, "loginSuccessUrl" : { "title" : "Login Success URL", "description" : "URL or ClientType|URL if client specific. URL without http(s) protocol will be appended to the current URI.", "propertyOrder" : 200, "required" : true, "items" : { "type" : "string" }, "type" : "array", "exampleValue" : "" }, "loginPostProcessClass" : { "title" : "Authentication Post Processing Classes", "description" : "Example: com.abc.authentication.PostProcessClass", "propertyOrder" : 400, "required" : true, "items" : { "type" : "string" }, "type" : "array", "exampleValue" : "" } } }
delete
Usage
am> delete AuthenticationChains --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 AuthenticationChains --realm Realm --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action AuthenticationChains --realm Realm --actionName getCreatableTypes
nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
Usage
am> action AuthenticationChains --realm Realm --actionName nextdescendents
query
Get the full list of instances of this collection. This query only supports _queryFilter=true filter.
Usage
am> query AuthenticationChains --realm Realm --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
read
Usage
am> read AuthenticationChains --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
update
Usage
am> update AuthenticationChains --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" : { "loginFailureUrl" : { "title" : "Login Failed URL", "description" : "URL or ClientType|URL if client specific. URL without http(s) protocol will be appended to the current URI.", "propertyOrder" : 300, "required" : true, "items" : { "type" : "string" }, "type" : "array", "exampleValue" : "" }, "authChainConfiguration" : { "title" : "Authentication Configuration", "description" : "", "propertyOrder" : 100, "required" : true, "exampleValue" : "", "type" : "array", "items" : { "type" : "object", "properties" : { "module" : { "type" : "string" }, "criteria" : { "type" : "string" }, "options" : { "type" : "object", "patternProperties" : { ".*" : { "type" : "string" } } } } } }, "loginSuccessUrl" : { "title" : "Login Success URL", "description" : "URL or ClientType|URL if client specific. URL without http(s) protocol will be appended to the current URI.", "propertyOrder" : 200, "required" : true, "items" : { "type" : "string" }, "type" : "array", "exampleValue" : "" }, "loginPostProcessClass" : { "title" : "Authentication Post Processing Classes", "description" : "Example: com.abc.authentication.PostProcessClass", "propertyOrder" : 400, "required" : true, "items" : { "type" : "string" }, "type" : "array", "exampleValue" : "" } } }
Global Operations
Resource path:
/global-config/authentication/chains
Resource version: 1.0
getAllTypes
Obtain the collection of all secondary configuration types related to the resource.
Usage
am> action AuthenticationChains --global --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action AuthenticationChains --global --actionName getCreatableTypes
nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
Usage
am> action AuthenticationChains --global --actionName nextdescendents
update
Usage
am> update AuthenticationChains --global --body body
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "dynamic" : { "properties" : { "authChainConfiguration" : { "title" : "Authentication Configuration", "description" : "", "propertyOrder" : 100, "required" : true, "type" : "string", "exampleValue" : "" } }, "type" : "object", "title" : "Dynamic Attributes" } } }