---
title: CertificateUserExtractorNode
description: Resource path:
component: pingam
version: 7.2
page_id: pingam:entity-reference:sec-amster-entity-certificateuserextractornode
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-certificateuserextractornode.html
llms_txt: https://docs.pingidentity.com/pingam/llms.txt
docs_for_agents: https://developer.pingidentity.com/build-with-ai/docs-for-agents.md
superseded_by: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-certificateuserextractornode.html
section_ids:
  sec-amster-entity-certificateuserextractornode-realm-ops: Realm Operations
  sec-amster-entity-certificateuserextractornode-realm-ops-create: create
  sec-amster-entity-certificateuserextractornode-realm-ops-delete: delete
  sec-amster-entity-certificateuserextractornode-realm-ops-getalltypes: getAllTypes
  sec-amster-entity-certificateuserextractornode-realm-ops-getcreatabletypes: getCreatableTypes
  sec-amster-entity-certificateuserextractornode-realm-ops-listoutcomes: listOutcomes
  sec-amster-entity-certificateuserextractornode-realm-ops-nextdescendents: nextdescendents
  sec-amster-entity-certificateuserextractornode-realm-ops-query: query
  sec-amster-entity-certificateuserextractornode-realm-ops-read: read
  sec-amster-entity-certificateuserextractornode-realm-ops-update: update
---

# CertificateUserExtractorNode

## Realm Operations

Resource path:

```
/realm-config/authentication/authenticationtrees/nodes/product-CertificateUserExtractorNode
```

Resource version: `1.0`

### create

**Usage**

```
am> create CertificateUserExtractorNode --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" : {
      "certificateAttributeProfileMappingExtension" : {
        "title" : "SubjectAltNameExt Value Type to Access User Profile",
        "description" : "Use the Subject Alternative Name Field in preference to one of the standard certificate fields.<br><br>Selecting RFC822Name or UPN will cause this field to have have precedence over the <em>Certificate Field Used to Access User Profile</em> or <em>Other Certificate Field Used to Access User Profile</em> attribute.",
        "propertyOrder" : 300,
        "type" : "string",
        "exampleValue" : ""
      },
      "certificateAttributeToProfileMapping" : {
        "title" : "Certificate Field Used to Access User Profile",
        "description" : "The certificate node needs to read a value from the client certificate that can be used to search the LDAP server for the user. This value from the certificate will be populated in shared state under the username key.",
        "propertyOrder" : 100,
        "type" : "string",
        "exampleValue" : ""
      },
      "otherCertificateAttributeToProfileMapping" : {
        "title" : "Other Certificate Field Used to Access User Profile",
        "description" : "This field is only used if the <em>Certificate Field Used to Access User Profile</em> attribute is set to <em>other</em>. This field allows a custom certificate field to be used as the basis of the user search.",
        "propertyOrder" : 200,
        "type" : "string",
        "exampleValue" : ""
      }
    },
    "required" : [ "certificateAttributeToProfileMapping", "certificateAttributeProfileMappingExtension" ]
  }
  ```

### delete

**Usage**

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

### getCreatableTypes

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

**Usage**

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

### listOutcomes

List the available outcomes for the node type.

**Usage**

```
am> action CertificateUserExtractorNode --realm Realm --body body --actionName listOutcomes
```

**Parameters**

* *\--body*

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

  ```json
  {
    "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 CertificateUserExtractorNode --realm Realm --actionName nextdescendents
```

### query

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

**Usage**

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

**Parameters**

* *\--filter*

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

### read

**Usage**

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

**Parameters**

* *\--id*

  The unique identifier for the resource.

### update

**Usage**

```
am> update CertificateUserExtractorNode --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" : {
      "certificateAttributeProfileMappingExtension" : {
        "title" : "SubjectAltNameExt Value Type to Access User Profile",
        "description" : "Use the Subject Alternative Name Field in preference to one of the standard certificate fields.<br><br>Selecting RFC822Name or UPN will cause this field to have have precedence over the <em>Certificate Field Used to Access User Profile</em> or <em>Other Certificate Field Used to Access User Profile</em> attribute.",
        "propertyOrder" : 300,
        "type" : "string",
        "exampleValue" : ""
      },
      "certificateAttributeToProfileMapping" : {
        "title" : "Certificate Field Used to Access User Profile",
        "description" : "The certificate node needs to read a value from the client certificate that can be used to search the LDAP server for the user. This value from the certificate will be populated in shared state under the username key.",
        "propertyOrder" : 100,
        "type" : "string",
        "exampleValue" : ""
      },
      "otherCertificateAttributeToProfileMapping" : {
        "title" : "Other Certificate Field Used to Access User Profile",
        "description" : "This field is only used if the <em>Certificate Field Used to Access User Profile</em> attribute is set to <em>other</em>. This field allows a custom certificate field to be used as the basis of the user search.",
        "propertyOrder" : 200,
        "type" : "string",
        "exampleValue" : ""
      }
    },
    "required" : [ "certificateAttributeToProfileMapping", "certificateAttributeProfileMappingExtension" ]
  }
  ```