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

# SocialAuthentication

## Realm Operations

Resource path:

```
/realm-config/services/socialauthentication
```

Resource version: `0.0`

### create

**Usage**

```
am> create SocialAuthentication --realm Realm --body body
```

**Parameters**

* *\--body*

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

  ```json
  {
    "type" : "object",
    "properties" : {
      "displayNames" : {
        "title" : "Display Names",
        "description" : "The display names for the implementations - this will be used to provide a name for the icon displayed on the login page. The key should be used across all the settings on this page to join them together.<br><br>For example:<table><tr><th>Key</th><th>Value</th></tr><tr><td>google</td><td>Google</td></tr></table>",
        "propertyOrder" : 100,
        "required" : false,
        "patternProperties" : {
          ".*" : {
            "type" : "string"
          }
        },
        "type" : "object",
        "exampleValue" : ""
      },
      "icons" : {
        "title" : "Icons",
        "description" : "Either a full URL or a path relative to the base of the site/server where the image can be found. The image will be used on the login page to link to the authentication chain defined above. The key should correspond to a key used to define a Display Name above.<br><br>For example:<table><tr><th>Key</th><th>Value</th></tr><tr><td>google</td><td>/images/google-sign-in.png</td></tr></table>",
        "propertyOrder" : 300,
        "required" : false,
        "patternProperties" : {
          ".*" : {
            "type" : "string"
          }
        },
        "type" : "object",
        "exampleValue" : ""
      },
      "authenticationChains" : {
        "title" : "Authentication Chains",
        "description" : "The name of the authentication chains that are the entry points to being authenticated by each respective social authentication provider. The key should correspond to a key used to define a Display Name above.<br><br>For example:<table><tr><th>Key</th><th>Value</th></tr><tr><td>google</td><td>socialAuthChainGoogle</td></tr></table>",
        "propertyOrder" : 200,
        "required" : false,
        "patternProperties" : {
          ".*" : { }
        },
        "type" : "object",
        "exampleValue" : ""
      },
      "enabledKeys" : {
        "title" : "Enabled Implementations",
        "description" : "Provide a key that has been used to define the settings above to enable that set of settings.<br><br>For example: google",
        "propertyOrder" : 400,
        "required" : true,
        "items" : {
          "type" : "string"
        },
        "type" : "array",
        "exampleValue" : ""
      }
    }
  }
  ```

### delete

**Usage**

```
am> delete SocialAuthentication --realm Realm
```

### getAllTypes

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

**Usage**

```
am> action SocialAuthentication --realm Realm --actionName getAllTypes
```

### getCreatableTypes

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

**Usage**

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

### nextdescendents

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

**Usage**

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

### read

**Usage**

```
am> read SocialAuthentication --realm Realm
```

### update

**Usage**

```
am> update SocialAuthentication --realm Realm --body body
```

**Parameters**

* *\--body*

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

  ```json
  {
    "type" : "object",
    "properties" : {
      "displayNames" : {
        "title" : "Display Names",
        "description" : "The display names for the implementations - this will be used to provide a name for the icon displayed on the login page. The key should be used across all the settings on this page to join them together.<br><br>For example:<table><tr><th>Key</th><th>Value</th></tr><tr><td>google</td><td>Google</td></tr></table>",
        "propertyOrder" : 100,
        "required" : false,
        "patternProperties" : {
          ".*" : {
            "type" : "string"
          }
        },
        "type" : "object",
        "exampleValue" : ""
      },
      "icons" : {
        "title" : "Icons",
        "description" : "Either a full URL or a path relative to the base of the site/server where the image can be found. The image will be used on the login page to link to the authentication chain defined above. The key should correspond to a key used to define a Display Name above.<br><br>For example:<table><tr><th>Key</th><th>Value</th></tr><tr><td>google</td><td>/images/google-sign-in.png</td></tr></table>",
        "propertyOrder" : 300,
        "required" : false,
        "patternProperties" : {
          ".*" : {
            "type" : "string"
          }
        },
        "type" : "object",
        "exampleValue" : ""
      },
      "authenticationChains" : {
        "title" : "Authentication Chains",
        "description" : "The name of the authentication chains that are the entry points to being authenticated by each respective social authentication provider. The key should correspond to a key used to define a Display Name above.<br><br>For example:<table><tr><th>Key</th><th>Value</th></tr><tr><td>google</td><td>socialAuthChainGoogle</td></tr></table>",
        "propertyOrder" : 200,
        "required" : false,
        "patternProperties" : {
          ".*" : { }
        },
        "type" : "object",
        "exampleValue" : ""
      },
      "enabledKeys" : {
        "title" : "Enabled Implementations",
        "description" : "Provide a key that has been used to define the settings above to enable that set of settings.<br><br>For example: google",
        "propertyOrder" : 400,
        "required" : true,
        "items" : {
          "type" : "string"
        },
        "type" : "array",
        "exampleValue" : ""
      }
    }
  }
  ```

## Global Operations

Resource path:

```
/global-config/services/socialauthentication
```

Resource version: `1.0`

### getAllTypes

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

**Usage**

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

### getCreatableTypes

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

**Usage**

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

### nextdescendents

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

**Usage**

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

### read

**Usage**

```
am> read SocialAuthentication --global
```

### update

**Usage**

```
am> update SocialAuthentication --global --body body
```

**Parameters**

* *\--body*

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

  ```json
  {
    "type" : "object",
    "properties" : {
      "defaults" : {
        "properties" : {
          "icons" : {
            "title" : "Icons",
            "description" : "Either a full URL or a path relative to the base of the site/server where the image can be found. The image will be used on the login page to link to the authentication chain defined above. The key should correspond to a key used to define a Display Name above.<br><br>For example:<table><tr><th>Key</th><th>Value</th></tr><tr><td>google</td><td>/images/google-sign-in.png</td></tr></table>",
            "propertyOrder" : 300,
            "required" : false,
            "patternProperties" : {
              ".*" : {
                "type" : "string"
              }
            },
            "type" : "object",
            "exampleValue" : ""
          },
          "enabledKeys" : {
            "title" : "Enabled Implementations",
            "description" : "Provide a key that has been used to define the settings above to enable that set of settings.<br><br>For example: google",
            "propertyOrder" : 400,
            "required" : true,
            "items" : {
              "type" : "string"
            },
            "type" : "array",
            "exampleValue" : ""
          },
          "authenticationChains" : {
            "title" : "Authentication Chains",
            "description" : "The name of the authentication chains that are the entry points to being authenticated by each respective social authentication provider. The key should correspond to a key used to define a Display Name above.<br><br>For example:<table><tr><th>Key</th><th>Value</th></tr><tr><td>google</td><td>socialAuthChainGoogle</td></tr></table>",
            "propertyOrder" : 200,
            "required" : false,
            "patternProperties" : {
              ".*" : { }
            },
            "type" : "object",
            "exampleValue" : ""
          },
          "displayNames" : {
            "title" : "Display Names",
            "description" : "The display names for the implementations - this will be used to provide a name for the icon displayed on the login page. The key should be used across all the settings on this page to join them together.<br><br>For example:<table><tr><th>Key</th><th>Value</th></tr><tr><td>google</td><td>Google</td></tr></table>",
            "propertyOrder" : 100,
            "required" : false,
            "patternProperties" : {
              ".*" : {
                "type" : "string"
              }
            },
            "type" : "object",
            "exampleValue" : ""
          }
        },
        "type" : "object",
        "title" : "Realm Defaults"
      }
    }
  }
  ```