---
title: AuthenticatorPushRegistrationModule
description: Resource path:
component: pingam
version: 8.1
page_id: pingam:entity-reference:sec-amster-entity-authenticatorpushregistrationmodule
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-authenticatorpushregistrationmodule.html
section_ids:
  sec-amster-entity-authenticatorpushregistrationmodule-realm-ops: Realm Operations
  sec-amster-entity-authenticatorpushregistrationmodule-realm-ops-create: create
  sec-amster-entity-authenticatorpushregistrationmodule-realm-ops-delete: delete
  sec-amster-entity-authenticatorpushregistrationmodule-realm-ops-getalltypes: getAllTypes
  sec-amster-entity-authenticatorpushregistrationmodule-realm-ops-getcreatabletypes: getCreatableTypes
  sec-amster-entity-authenticatorpushregistrationmodule-realm-ops-nextdescendents: nextdescendents
  sec-amster-entity-authenticatorpushregistrationmodule-realm-ops-query: query
  sec-amster-entity-authenticatorpushregistrationmodule-realm-ops-read: read
  sec-amster-entity-authenticatorpushregistrationmodule-realm-ops-update: update
  sec-amster-entity-authenticatorpushregistrationmodule-global-ops: Global Operations
  sec-amster-entity-authenticatorpushregistrationmodule-global-ops-getalltypes: getAllTypes
  sec-amster-entity-authenticatorpushregistrationmodule-global-ops-getcreatabletypes: getCreatableTypes
  sec-amster-entity-authenticatorpushregistrationmodule-global-ops-nextdescendents: nextdescendents
  sec-amster-entity-authenticatorpushregistrationmodule-global-ops-read: read
  sec-amster-entity-authenticatorpushregistrationmodule-global-ops-update: update
---

# AuthenticatorPushRegistrationModule

## Realm Operations

Resource path:

```
/realm-config/authentication/modules/authPushReg
```

Resource version: `0.0`

### create

**Usage**

```
am> create AuthenticatorPushRegistrationModule --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" : {
      "googleLink" : {
        "title" : "Google Play URL",
        "description" : "URL of the app to download on Google Play.",
        "propertyOrder" : 700,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "timeoutInMilliSecconds" : {
        "title" : "Registration Response Timeout (ms)",
        "description" : "The period of time (in milliseconds) within which the registration QR code should be replied to.",
        "propertyOrder" : 300,
        "required" : true,
        "type" : "integer",
        "exampleValue" : ""
      },
      "imgUrl" : {
        "title" : "Image URL",
        "description" : "The location of the image to download and display as your identity issuer's logo within the mobile app.",
        "propertyOrder" : 500,
        "required" : true,
        "type" : "string",
        "exampleValue" : "http://example.com/image.png"
      },
      "issuer" : {
        "title" : "Issuer Name",
        "description" : "The Name of the service as it will appear on the registered device.",
        "propertyOrder" : 200,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "authenticationLevel" : {
        "title" : "Authentication Level",
        "description" : "The authentication level associated with this module.<br><br>Each authentication module has an authentication level that can be used to indicate the level of security associated with the module; 0 is the lowest (and the default).",
        "propertyOrder" : 100,
        "required" : true,
        "type" : "integer",
        "exampleValue" : ""
      },
      "appleLink" : {
        "title" : "App Store App URL",
        "description" : "URL of the app to download on the App Store.",
        "propertyOrder" : 600,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "bgcolour" : {
        "title" : "Background Colour",
        "description" : "The background colour of the image to display behind your identity issuer's logo within the mobile app.",
        "propertyOrder" : 400,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      }
    }
  }
  ```

### delete

**Usage**

```
am> delete AuthenticatorPushRegistrationModule --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 AuthenticatorPushRegistrationModule --realm Realm --actionName getAllTypes
```

### getCreatableTypes

Obtain the collection of secondary configuration types that have yet to be added to the resource.

**Usage**

```
am> action AuthenticatorPushRegistrationModule --realm Realm --actionName getCreatableTypes
```

### nextdescendents

Obtain the collection of secondary configuration instances that have been added to the resource.

**Usage**

```
am> action AuthenticatorPushRegistrationModule --realm Realm --actionName nextdescendents
```

### query

Get the full list of instances of this collection. This query only supports `_queryFilter=true` filter.

**Usage**

```
am> query AuthenticatorPushRegistrationModule --realm Realm --filter filter
```

**Parameters**

* *\--filter*

  A CREST formatted query filter, where "true" will query all.

### read

**Usage**

```
am> read AuthenticatorPushRegistrationModule --realm Realm --id id
```

**Parameters**

* *\--id*

  The unique identifier for the resource.

### update

**Usage**

```
am> update AuthenticatorPushRegistrationModule --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" : {
      "googleLink" : {
        "title" : "Google Play URL",
        "description" : "URL of the app to download on Google Play.",
        "propertyOrder" : 700,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "timeoutInMilliSecconds" : {
        "title" : "Registration Response Timeout (ms)",
        "description" : "The period of time (in milliseconds) within which the registration QR code should be replied to.",
        "propertyOrder" : 300,
        "required" : true,
        "type" : "integer",
        "exampleValue" : ""
      },
      "imgUrl" : {
        "title" : "Image URL",
        "description" : "The location of the image to download and display as your identity issuer's logo within the mobile app.",
        "propertyOrder" : 500,
        "required" : true,
        "type" : "string",
        "exampleValue" : "http://example.com/image.png"
      },
      "issuer" : {
        "title" : "Issuer Name",
        "description" : "The Name of the service as it will appear on the registered device.",
        "propertyOrder" : 200,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "authenticationLevel" : {
        "title" : "Authentication Level",
        "description" : "The authentication level associated with this module.<br><br>Each authentication module has an authentication level that can be used to indicate the level of security associated with the module; 0 is the lowest (and the default).",
        "propertyOrder" : 100,
        "required" : true,
        "type" : "integer",
        "exampleValue" : ""
      },
      "appleLink" : {
        "title" : "App Store App URL",
        "description" : "URL of the app to download on the App Store.",
        "propertyOrder" : 600,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "bgcolour" : {
        "title" : "Background Colour",
        "description" : "The background colour of the image to display behind your identity issuer's logo within the mobile app.",
        "propertyOrder" : 400,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      }
    }
  }
  ```

## Global Operations

Resource path:

```
/global-config/authentication/modules/authPushReg
```

Resource version: `1.0`

### getAllTypes

Obtain the collection of all secondary configuration types related to the resource.

**Usage**

```
am> action AuthenticatorPushRegistrationModule --global --actionName getAllTypes
```

### getCreatableTypes

Obtain the collection of secondary configuration types that have yet to be added to the resource.

**Usage**

```
am> action AuthenticatorPushRegistrationModule --global --actionName getCreatableTypes
```

### nextdescendents

Obtain the collection of secondary configuration instances that have been added to the resource.

**Usage**

```
am> action AuthenticatorPushRegistrationModule --global --actionName nextdescendents
```

### read

**Usage**

```
am> read AuthenticatorPushRegistrationModule --global
```

### update

**Usage**

```
am> update AuthenticatorPushRegistrationModule --global --body body
```

**Parameters**

* *\--body*

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

  ```json
  {
    "type" : "object",
    "properties" : {
      "defaults" : {
        "properties" : {
          "issuer" : {
            "title" : "Issuer Name",
            "description" : "The Name of the service as it will appear on the registered device.",
            "propertyOrder" : 200,
            "required" : true,
            "type" : "string",
            "exampleValue" : ""
          },
          "appleLink" : {
            "title" : "App Store App URL",
            "description" : "URL of the app to download on the App Store.",
            "propertyOrder" : 600,
            "required" : true,
            "type" : "string",
            "exampleValue" : ""
          },
          "imgUrl" : {
            "title" : "Image URL",
            "description" : "The location of the image to download and display as your identity issuer's logo within the mobile app.",
            "propertyOrder" : 500,
            "required" : true,
            "type" : "string",
            "exampleValue" : "http://example.com/image.png"
          },
          "bgcolour" : {
            "title" : "Background Colour",
            "description" : "The background colour of the image to display behind your identity issuer's logo within the mobile app.",
            "propertyOrder" : 400,
            "required" : true,
            "type" : "string",
            "exampleValue" : ""
          },
          "googleLink" : {
            "title" : "Google Play URL",
            "description" : "URL of the app to download on Google Play.",
            "propertyOrder" : 700,
            "required" : true,
            "type" : "string",
            "exampleValue" : ""
          },
          "timeoutInMilliSecconds" : {
            "title" : "Registration Response Timeout (ms)",
            "description" : "The period of time (in milliseconds) within which the registration QR code should be replied to.",
            "propertyOrder" : 300,
            "required" : true,
            "type" : "integer",
            "exampleValue" : ""
          },
          "authenticationLevel" : {
            "title" : "Authentication Level",
            "description" : "The authentication level associated with this module.<br><br>Each authentication module has an authentication level that can be used to indicate the level of security associated with the module; 0 is the lowest (and the default).",
            "propertyOrder" : 100,
            "required" : true,
            "type" : "integer",
            "exampleValue" : ""
          }
        },
        "type" : "object",
        "title" : "Realm Defaults"
      }
    }
  }
  ```