PatchObject
Realm Operations
Resource path:
/realm-config/authentication/authenticationtrees/nodes/PatchObjectNode
Resource version: 2.0
create
Usage
am> create PatchObject --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" : { "ignoredFields" : { "title" : "Ignored Fields", "description" : "Fields from sharedState that should be ignored as part of patch. If empty, all fields are attempted as part of the patch.", "propertyOrder" : 200, "items" : { "type" : "string" }, "type" : "array", "exampleValue" : "" }, "identityAttribute" : { "title" : "Identity Attribute", "description" : "The attribute used to identify the the object in IDM.", "propertyOrder" : 400, "type" : "string", "exampleValue" : "" }, "identityResource" : { "title" : "Identity Resource", "description" : "The identity resource in IDM that this node will patch. This is used to aid node input requirement declaration. Must match identity resource of the current tree.", "propertyOrder" : 300, "type" : "string", "exampleValue" : "" }, "patchAsObject" : { "title" : "Patch As Object", "description" : "Whether the patch should be done as object or client. Defaults to false, which represents the oauth client.", "propertyOrder" : 100, "type" : "boolean", "exampleValue" : "" } }, "required" : [ "ignoredFields", "identityAttribute", "identityResource", "patchAsObject" ] }
delete
Usage
am> delete PatchObject --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 PatchObject --realm Realm --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action PatchObject --realm Realm --actionName getCreatableTypes
listOutcomes
List the available outcomes for the node type.
Usage
am> action PatchObject --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 PatchObject --realm Realm --actionName nextdescendents
query
Get the full list of instances of this collection. This query only supports _queryFilter=true filter.
Usage
am> query PatchObject --realm Realm --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
read
Usage
am> read PatchObject --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
update
Usage
am> update PatchObject --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" : { "ignoredFields" : { "title" : "Ignored Fields", "description" : "Fields from sharedState that should be ignored as part of patch. If empty, all fields are attempted as part of the patch.", "propertyOrder" : 200, "items" : { "type" : "string" }, "type" : "array", "exampleValue" : "" }, "identityAttribute" : { "title" : "Identity Attribute", "description" : "The attribute used to identify the the object in IDM.", "propertyOrder" : 400, "type" : "string", "exampleValue" : "" }, "identityResource" : { "title" : "Identity Resource", "description" : "The identity resource in IDM that this node will patch. This is used to aid node input requirement declaration. Must match identity resource of the current tree.", "propertyOrder" : 300, "type" : "string", "exampleValue" : "" }, "patchAsObject" : { "title" : "Patch As Object", "description" : "Whether the patch should be done as object or client. Defaults to false, which represents the oauth client.", "propertyOrder" : 100, "type" : "boolean", "exampleValue" : "" } }, "required" : [ "ignoredFields", "identityAttribute", "identityResource", "patchAsObject" ] }