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

# AuthenticateThing

## Realm Operations

Resource path:

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

Resource version: `3.0`

### create

**Usage**

```
am> create AuthenticateThing --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" : {
      "jwtAuthenticationMethod" : {
        "title" : "JWT Authentication Method",
        "description" : "Choose the required JWT authentication method.</br><p>Proof of Possession: Prove that the signer of the JWT is the owner of the key by including a challenge nonce in the JWT. Validation will be done in accordance with the <a href=\"https://tools.ietf.org/html/rfc7800\">JWT Proof of Possession specification</a>.</p><p>Client Assertion: Present a JWT Bearer token for authentication. Validation will be done in accordance with the <a href=\"https://datatracker.ietf.org/doc/html/rfc7523#section-3\">OAuth 2.0 JWT Profile for Client Authentication</a>.</p>",
        "propertyOrder" : 10,
        "type" : "string",
        "exampleValue" : ""
      },
      "issueRestrictedToken" : {
        "title" : "Issue Restricted Token",
        "description" : "The session token issued on successful authentication will be modified by adding a proof of possession restriction to it. Any requests accompanied by the token must be signed with the key that was used to sign the authentication JWT.",
        "propertyOrder" : 20,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "additionalAudienceValues" : {
        "title" : "Additional Audience Values",
        "description" : "The additional audience values that will be permitted when verifying JWTs. These audience values will be in addition to the AM base, issuer and token endpoint URIs for the Client Assertion authentication method or the realm path for Proof of Possession.",
        "propertyOrder" : 30,
        "items" : {
          "type" : "string"
        },
        "type" : "array",
        "exampleValue" : ""
      }
    },
    "required" : [ "jwtAuthenticationMethod", "issueRestrictedToken", "additionalAudienceValues" ]
  }
  ```

### delete

**Usage**

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

### getUpgradedConfig

Get the upgraded configuration for the node type.

**Usage**

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

**Parameters**

* *\--filter*

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

### read

**Usage**

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

**Parameters**

* *\--id*

  The unique identifier for the resource.

### update

**Usage**

```
am> update AuthenticateThing --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" : {
      "jwtAuthenticationMethod" : {
        "title" : "JWT Authentication Method",
        "description" : "Choose the required JWT authentication method.</br><p>Proof of Possession: Prove that the signer of the JWT is the owner of the key by including a challenge nonce in the JWT. Validation will be done in accordance with the <a href=\"https://tools.ietf.org/html/rfc7800\">JWT Proof of Possession specification</a>.</p><p>Client Assertion: Present a JWT Bearer token for authentication. Validation will be done in accordance with the <a href=\"https://datatracker.ietf.org/doc/html/rfc7523#section-3\">OAuth 2.0 JWT Profile for Client Authentication</a>.</p>",
        "propertyOrder" : 10,
        "type" : "string",
        "exampleValue" : ""
      },
      "issueRestrictedToken" : {
        "title" : "Issue Restricted Token",
        "description" : "The session token issued on successful authentication will be modified by adding a proof of possession restriction to it. Any requests accompanied by the token must be signed with the key that was used to sign the authentication JWT.",
        "propertyOrder" : 20,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "additionalAudienceValues" : {
        "title" : "Additional Audience Values",
        "description" : "The additional audience values that will be permitted when verifying JWTs. These audience values will be in addition to the AM base, issuer and token endpoint URIs for the Client Assertion authentication method or the realm path for Proof of Possession.",
        "propertyOrder" : 30,
        "items" : {
          "type" : "string"
        },
        "type" : "array",
        "exampleValue" : ""
      }
    },
    "required" : [ "jwtAuthenticationMethod", "issueRestrictedToken", "additionalAudienceValues" ]
  }
  ```

### versionInfo

List the versions available for the node type.

**Usage**

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