GetAuthenticatorApp
Realm Operations
Resource path:
/realm-config/authentication/authenticationtrees/nodes/GetAuthenticatorAppNode
Resource version: 1.0
create
Usage
am> create GetAuthenticatorApp --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" : { "continueLabel" : { "title" : "Continue Label", "description" : "Localization for Continue button.", "propertyOrder" : 20, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "appleLink" : { "title" : "Apple App Store URL", "description" : "URL of the app to download on the Apple App Store.", "propertyOrder" : 30, "type" : "string", "exampleValue" : "" }, "message" : { "title" : "Get App Authenticator Message", "description" : "Localized message providing the authenticator app links. The keys {{appleLink}} and {{googleLink}} are used as wildcards. The default message is: Get the app from the {{appleLink}} or on {{googleLink}}. You can also use {{appleLabel}} and {{googleLabel}} to customize the message including HTML elements, e.g.: Apple: <a target='_blank' href='{{appleLink}}'>{{appleLabel}}</a>", "propertyOrder" : 10, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "googleLink" : { "title" : "Google Play URL", "description" : "URL of the app to download on the Google Play Store.", "propertyOrder" : 40, "type" : "string", "exampleValue" : "" } }, "required" : [ "message", "continueLabel", "appleLink", "googleLink" ] }
delete
Usage
am> delete GetAuthenticatorApp --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 GetAuthenticatorApp --realm Realm --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action GetAuthenticatorApp --realm Realm --actionName getCreatableTypes
listOutcomes
List the available outcomes for the node type.
Usage
am> action GetAuthenticatorApp --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 GetAuthenticatorApp --realm Realm --actionName nextdescendents
query
Get the full list of instances of this collection. This query only supports _queryFilter=true filter.
Usage
am> query GetAuthenticatorApp --realm Realm --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
read
Usage
am> read GetAuthenticatorApp --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
update
Usage
am> update GetAuthenticatorApp --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" : { "continueLabel" : { "title" : "Continue Label", "description" : "Localization for Continue button.", "propertyOrder" : 20, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "appleLink" : { "title" : "Apple App Store URL", "description" : "URL of the app to download on the Apple App Store.", "propertyOrder" : 30, "type" : "string", "exampleValue" : "" }, "message" : { "title" : "Get App Authenticator Message", "description" : "Localized message providing the authenticator app links. The keys {{appleLink}} and {{googleLink}} are used as wildcards. The default message is: Get the app from the {{appleLink}} or on {{googleLink}}. You can also use {{appleLabel}} and {{googleLabel}} to customize the message including HTML elements, e.g.: Apple: <a target='_blank' href='{{appleLink}}'>{{appleLabel}}</a>", "propertyOrder" : 10, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "googleLink" : { "title" : "Google Play URL", "description" : "URL of the app to download on the Google Play Store.", "propertyOrder" : 40, "type" : "string", "exampleValue" : "" } }, "required" : [ "message", "continueLabel", "appleLink", "googleLink" ] }