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

# DeviceGeofencing

## Realm Operations

Resource path:

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

Resource version: `3.0`

### create

**Usage**

```
am> create DeviceGeofencing --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" : {
      "locations" : {
        "title" : "Trusted Locations",
        "description" : "Specify the latitude and longitude of trusted locations. Separate the values with a comma; for example, `-123.177201,49.164532`.",
        "propertyOrder" : 100,
        "items" : {
          "type" : "string"
        },
        "minItems" : 1,
        "type" : "array",
        "exampleValue" : ""
      },
      "distance" : {
        "title" : "Geofence Radius (km)",
        "description" : "Specifies the maximum distance, in kilometers, that a device can be from the specified trusted location(s).",
        "propertyOrder" : 200,
        "type" : "string",
        "exampleValue" : ""
      }
    },
    "required" : [ "locations", "distance" ]
  }
  ```

### delete

**Usage**

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

### getUpgradedConfig

Get the upgraded configuration for the node type.

**Usage**

```
am> action DeviceGeofencing --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 DeviceGeofencing --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 DeviceGeofencing --realm Realm --filter filter
```

**Parameters**

* *\--filter*

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

### read

**Usage**

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

**Parameters**

* *\--id*

  The unique identifier for the resource.

### update

**Usage**

```
am> update DeviceGeofencing --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" : {
      "locations" : {
        "title" : "Trusted Locations",
        "description" : "Specify the latitude and longitude of trusted locations. Separate the values with a comma; for example, `-123.177201,49.164532`.",
        "propertyOrder" : 100,
        "items" : {
          "type" : "string"
        },
        "minItems" : 1,
        "type" : "array",
        "exampleValue" : ""
      },
      "distance" : {
        "title" : "Geofence Radius (km)",
        "description" : "Specifies the maximum distance, in kilometers, that a device can be from the specified trusted location(s).",
        "propertyOrder" : 200,
        "type" : "string",
        "exampleValue" : ""
      }
    },
    "required" : [ "locations", "distance" ]
  }
  ```

### versionInfo

List the versions available for the node type.

**Usage**

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