ScriptStore
Realm Operations
Resource path:
/realm-config/services/scripts
Resource version: 2.0
create
Usage
am> create ScriptStore --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" : { "createdBy" : { "title" : "Created by", "description" : "A string containing the universal identifier DN of the subject that created the script", "propertyOrder" : 600, "required" : true, "type" : "string", "exampleValue" : "" }, "script" : { "title" : "Script", "description" : "The source code of the script. The source code is in UTF-8 format and encoded into Base64", "propertyOrder" : 500, "required" : true, "type" : "string", "exampleValue" : "" }, "name" : { "title" : "Script name", "description" : "The name provided for the script", "propertyOrder" : 100, "required" : true, "type" : "string", "exampleValue" : "" }, "context" : { "title" : "script.type", "description" : "The script type. Supported values are: POLICY_CONDITION : Policy Condition AUTHENTICATION_SERVER_SIDE : Server-side Authentication AUTHENTICATION_CLIENT_SIDE : Client-side Authentication - Note Client-side scripts must be written in JavaScript OIDC_CLAIMS : OIDC Claims SOCIAL_IDP_PROFILE_TRANSFORMATION : Social Identity Provider Profile Transformation", "propertyOrder" : 300, "required" : true, "type" : "string", "exampleValue" : "" }, "creationDate" : { "title" : "Creation date", "description" : "An integer containing the creation date and time, in ISO 8601 format", "propertyOrder" : 700, "required" : true, "type" : "string", "exampleValue" : "" }, "evaluatorVersion" : { "title" : "Script evaluator version", "description" : "", "propertyOrder" : 410, "required" : true, "type" : "string", "exampleValue" : "" }, "lastModifiedBy" : { "title" : "Last modifier", "description" : "A string containing the universal identifier DN of the subject that most recently updated the script. If the script has not been modified since it was created, this property will have the same value as createdBy", "propertyOrder" : 800, "required" : true, "type" : "string", "exampleValue" : "" }, "description" : { "title" : "Script description", "description" : "An optional text string to help identify the script", "propertyOrder" : 200, "required" : true, "type" : "string", "exampleValue" : "" }, "lastModifiedDate" : { "title" : "Last modification date", "description" : "A string containing the last modified date and time, in ISO 8601 format. If the script has not been modified since it was created, this property will have the same value as creationDate", "propertyOrder" : 900, "required" : true, "type" : "string", "exampleValue" : "" }, "language" : { "title" : "Script language", "description" : "The language the script is written in - JAVASCRIPT or GROOVY", "propertyOrder" : 400, "required" : true, "type" : "string", "exampleValue" : "" } } }
delete
Usage
am> delete ScriptStore --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 ScriptStore --realm Realm --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action ScriptStore --realm Realm --actionName getCreatableTypes
nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
Usage
am> action ScriptStore --realm Realm --actionName nextdescendents
query
Get the full list of instances of this collection. This query only supports _queryFilter=true filter.
Usage
am> query ScriptStore --realm Realm --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
read
Usage
am> read ScriptStore --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
update
Usage
am> update ScriptStore --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" : { "createdBy" : { "title" : "Created by", "description" : "A string containing the universal identifier DN of the subject that created the script", "propertyOrder" : 600, "required" : true, "type" : "string", "exampleValue" : "" }, "script" : { "title" : "Script", "description" : "The source code of the script. The source code is in UTF-8 format and encoded into Base64", "propertyOrder" : 500, "required" : true, "type" : "string", "exampleValue" : "" }, "name" : { "title" : "Script name", "description" : "The name provided for the script", "propertyOrder" : 100, "required" : true, "type" : "string", "exampleValue" : "" }, "context" : { "title" : "script.type", "description" : "The script type. Supported values are: POLICY_CONDITION : Policy Condition AUTHENTICATION_SERVER_SIDE : Server-side Authentication AUTHENTICATION_CLIENT_SIDE : Client-side Authentication - Note Client-side scripts must be written in JavaScript OIDC_CLAIMS : OIDC Claims SOCIAL_IDP_PROFILE_TRANSFORMATION : Social Identity Provider Profile Transformation", "propertyOrder" : 300, "required" : true, "type" : "string", "exampleValue" : "" }, "creationDate" : { "title" : "Creation date", "description" : "An integer containing the creation date and time, in ISO 8601 format", "propertyOrder" : 700, "required" : true, "type" : "string", "exampleValue" : "" }, "evaluatorVersion" : { "title" : "Script evaluator version", "description" : "", "propertyOrder" : 410, "required" : true, "type" : "string", "exampleValue" : "" }, "lastModifiedBy" : { "title" : "Last modifier", "description" : "A string containing the universal identifier DN of the subject that most recently updated the script. If the script has not been modified since it was created, this property will have the same value as createdBy", "propertyOrder" : 800, "required" : true, "type" : "string", "exampleValue" : "" }, "description" : { "title" : "Script description", "description" : "An optional text string to help identify the script", "propertyOrder" : 200, "required" : true, "type" : "string", "exampleValue" : "" }, "lastModifiedDate" : { "title" : "Last modification date", "description" : "A string containing the last modified date and time, in ISO 8601 format. If the script has not been modified since it was created, this property will have the same value as creationDate", "propertyOrder" : 900, "required" : true, "type" : "string", "exampleValue" : "" }, "language" : { "title" : "Script language", "description" : "The language the script is written in - JAVASCRIPT or GROOVY", "propertyOrder" : 400, "required" : true, "type" : "string", "exampleValue" : "" } } }