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

# TwitterClient

## Realm Operations

Resource path:

```
/realm-config/services/SocialIdentityProviders/twitterConfig
```

Resource version: `0.0`

### create

**Usage**

```
am> create TwitterClient --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" : {
      "requestTokenEndpoint" : {
        "title" : "Request Token Endpoint",
        "description" : "The endpoint for obtaining an access token.",
        "propertyOrder" : 800,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "tokenEndpoint" : {
        "title" : "Access Token Endpoint URL",
        "description" : "OAuth access token endpoint URL This is the URL endpoint for access token retrieval provided by the OAuth Identity Provider.Refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-3.2), section 3.2.",
        "propertyOrder" : 500,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "issuerComparisonCheckType" : {
        "title" : "Issuer comparison check",
        "description" : "Controls whether the comparison of the expected issuer value in IdToken matches the actual value of the \"iss\" claim. EXACT performs a spec compliant exact string comparison. REGEX takes the expected issuer value as a regular expression and performs a regular expression evaluation to determine if the actual issuer value is a match. If using the REGEX comparison take care in what the regular expression will allow and the performance characteristics of the provided regex.",
        "propertyOrder" : 10001,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "redirectURI" : {
        "title" : "Redirect URL",
        "description" : "",
        "propertyOrder" : 700,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "uiConfig" : {
        "title" : "UI Config Properties",
        "description" : "Mapping of display properties to be defined and consumed by the UI.",
        "propertyOrder" : 9999,
        "required" : true,
        "patternProperties" : {
          ".*" : {
            "type" : "string"
          }
        },
        "type" : "object",
        "exampleValue" : ""
      },
      "clientSecret" : {
        "title" : "Client Secret",
        "description" : "OAuth client_secret parameter <p>For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1. This property is deprecated. Use the Client Secret Label Identifier instead. AM ignores the Client Secret if you set a Client Secret Label Identifier.",
        "propertyOrder" : 300,
        "required" : true,
        "type" : "string",
        "format" : "password",
        "exampleValue" : ""
      },
      "clientId" : {
        "title" : "Client ID",
        "description" : "OAuth client_id parameter<p> For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1.",
        "propertyOrder" : 200,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "authenticationIdKey" : {
        "title" : "Auth ID Key",
        "description" : "Field used to identify a user by the social provider.",
        "propertyOrder" : 100,
        "required" : true,
        "type" : "string",
        "exampleValue" : "id_str"
      },
      "enabled" : {
        "title" : "Enabled",
        "description" : "",
        "propertyOrder" : 1,
        "required" : true,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "userInfoEndpoint" : {
        "title" : "User Profile Service URL",
        "description" : "User profile information URL <p> This URL endpoint provides user profile information and is provided by the OAuth Identity Provider NB This URL should return JSON objects in response.",
        "propertyOrder" : 600,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "transform" : {
        "title" : "Transform Script",
        "description" : "A script that takes the raw profile object as input and outputs the normalized profile object.",
        "propertyOrder" : 10000,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "authorizationEndpoint" : {
        "title" : "Authentication Endpoint URL",
        "description" : "OAuth authentication endpoint URL <p> This is the URL endpoint for OAuth authentication provided by the OAuth Identity Provider.",
        "propertyOrder" : 400,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      }
    }
  }
  ```

### delete

**Usage**

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

### getCreatableTypes

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

**Usage**

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

### nextdescendents

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

**Usage**

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

### query

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

**Usage**

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

**Parameters**

* *\--filter*

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

### read

**Usage**

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

**Parameters**

* *\--id*

  The unique identifier for the resource.

### update

**Usage**

```
am> update TwitterClient --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" : {
      "requestTokenEndpoint" : {
        "title" : "Request Token Endpoint",
        "description" : "The endpoint for obtaining an access token.",
        "propertyOrder" : 800,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "tokenEndpoint" : {
        "title" : "Access Token Endpoint URL",
        "description" : "OAuth access token endpoint URL This is the URL endpoint for access token retrieval provided by the OAuth Identity Provider.Refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-3.2), section 3.2.",
        "propertyOrder" : 500,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "issuerComparisonCheckType" : {
        "title" : "Issuer comparison check",
        "description" : "Controls whether the comparison of the expected issuer value in IdToken matches the actual value of the \"iss\" claim. EXACT performs a spec compliant exact string comparison. REGEX takes the expected issuer value as a regular expression and performs a regular expression evaluation to determine if the actual issuer value is a match. If using the REGEX comparison take care in what the regular expression will allow and the performance characteristics of the provided regex.",
        "propertyOrder" : 10001,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "redirectURI" : {
        "title" : "Redirect URL",
        "description" : "",
        "propertyOrder" : 700,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "uiConfig" : {
        "title" : "UI Config Properties",
        "description" : "Mapping of display properties to be defined and consumed by the UI.",
        "propertyOrder" : 9999,
        "required" : true,
        "patternProperties" : {
          ".*" : {
            "type" : "string"
          }
        },
        "type" : "object",
        "exampleValue" : ""
      },
      "clientSecret" : {
        "title" : "Client Secret",
        "description" : "OAuth client_secret parameter <p>For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1. This property is deprecated. Use the Client Secret Label Identifier instead. AM ignores the Client Secret if you set a Client Secret Label Identifier.",
        "propertyOrder" : 300,
        "required" : true,
        "type" : "string",
        "format" : "password",
        "exampleValue" : ""
      },
      "clientId" : {
        "title" : "Client ID",
        "description" : "OAuth client_id parameter<p> For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1.",
        "propertyOrder" : 200,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "authenticationIdKey" : {
        "title" : "Auth ID Key",
        "description" : "Field used to identify a user by the social provider.",
        "propertyOrder" : 100,
        "required" : true,
        "type" : "string",
        "exampleValue" : "id_str"
      },
      "enabled" : {
        "title" : "Enabled",
        "description" : "",
        "propertyOrder" : 1,
        "required" : true,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "userInfoEndpoint" : {
        "title" : "User Profile Service URL",
        "description" : "User profile information URL <p> This URL endpoint provides user profile information and is provided by the OAuth Identity Provider NB This URL should return JSON objects in response.",
        "propertyOrder" : 600,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "transform" : {
        "title" : "Transform Script",
        "description" : "A script that takes the raw profile object as input and outputs the normalized profile object.",
        "propertyOrder" : 10000,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "authorizationEndpoint" : {
        "title" : "Authentication Endpoint URL",
        "description" : "OAuth authentication endpoint URL <p> This is the URL endpoint for OAuth authentication provided by the OAuth Identity Provider.",
        "propertyOrder" : 400,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      }
    }
  }
  ```
