---
title: GetAuthenticatorApp
description: Resource path:
component: pingam
version: 8.1
page_id: pingam:entity-reference:sec-amster-entity-getauthenticatorapp
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-getauthenticatorapp.html
section_ids:
  sec-amster-entity-getauthenticatorapp-realm-ops: Realm Operations
  sec-amster-entity-getauthenticatorapp-realm-ops-create: create
  sec-amster-entity-getauthenticatorapp-realm-ops-delete: delete
  sec-amster-entity-getauthenticatorapp-realm-ops-gettype: getType
  sec-amster-entity-getauthenticatorapp-realm-ops-getupgradedconfig: getUpgradedConfig
  sec-amster-entity-getauthenticatorapp-realm-ops-query: query
  sec-amster-entity-getauthenticatorapp-realm-ops-read: read
  sec-amster-entity-getauthenticatorapp-realm-ops-update: update
  sec-amster-entity-getauthenticatorapp-realm-ops-versioninfo: versionInfo
---

# GetAuthenticatorApp

## Realm Operations

Resource path:

```
/realm-config/authentication/authenticationtrees/nodes/GetAuthenticatorAppNode/1.0
```

Resource version: `3.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:

  ```json
  {
    "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" : ""
      },
      "googleLink" : {
        "title" : "Google Play URL",
        "description" : "URL of the app to download on the Google Play Store.",
        "propertyOrder" : 40,
        "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" : ""
      }
    },
    "required" : [ "continueLabel", "appleLink", "googleLink", "message" ]
  }
  ```

### delete

**Usage**

```
am> delete GetAuthenticatorApp --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 GetAuthenticatorApp --realm Realm --actionName getType
```

### getUpgradedConfig

Get the upgraded configuration for the node type.

**Usage**

```
am> action GetAuthenticatorApp --realm Realm --body body --actionName getUpgradedConfig --targetVersion targetVersion
```

**Parameters**

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "type" : "object",
    "title" : "The current configuration of the node type."
  }
  ```

* *\--targetVersion*

  \=== 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:

  ```json
  {
    "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 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:

  ```json
  {
    "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" : ""
      },
      "googleLink" : {
        "title" : "Google Play URL",
        "description" : "URL of the app to download on the Google Play Store.",
        "propertyOrder" : 40,
        "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" : ""
      }
    },
    "required" : [ "continueLabel", "appleLink", "googleLink", "message" ]
  }
  ```

### versionInfo

List the versions available for the node type.

**Usage**

```
am> action GetAuthenticatorApp --realm Realm --actionName versionInfo
```