/socialProviders: Social Providers

URL:: https://[root]/portals/[portalID]/socialProviders
Methods:: POST
Operations:: Configure, Remove

Example usage

The following is a sample ArcGIS Online request URL used to access the socialProviders resource:

Use dark colors for code blocksCopy
https://org.arcgis.com/sharing/rest/portals/0123456789ABCDEF/socialProviders?f=pjson

The following is a sample ArcGIS Enterprise request URL used to access the socialProviders resource:

Use dark colors for code blocksCopy
https://machine.domain.com/webadaptor/sharing/rest/portals/0123456789ABCDEF/socialProviders?f=pjson

Description

The socialProviders resource returns the social login configuration properties for an organization.

Request parameters

Parameter	Details
`f`	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

Response properties

Property Details

Property	Details
`config`	A JSON object with `signUpMode`, `providers` properties that provides social login configuration of an organization. Empty object if org does not have social login enabled. Additional properties like `role`, `userLicenseType`, `userCreditAssignment` and `groups` are also available when organization has `Automatic` sign up mode. Example Use dark colors for code blocksCopy `1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 { "signUpMode": "Invitation", "providers": [ "facebook", "google", "apple", "github" ], "role": "org_user", "userCreditAssignment": 20, "groups": [ "ee318ee7826e42b7813dbd2462b64eaa", "019de89434b341c68b1d97762a0dcc9e" ], "userLicenseType": "creatorUT" }`

config

A JSON object with signUpMode, providers properties that provides social login configuration of an organization. Empty object if org does not have social login enabled. Additional properties like role, userLicenseType, userCreditAssignment and groups are also available when organization has Automatic sign up mode.

Example
Use dark colors for code blocksCopy
{
  "signUpMode": "Invitation",
  "providers": [
    "facebook",
    "google",
    "apple",
    "github"
  ],
  "role": "org_user",
  "userCreditAssignment": 20,
  "groups": [
    "ee318ee7826e42b7813dbd2462b64eaa",
    "019de89434b341c68b1d97762a0dcc9e"
  ],
  "userLicenseType": "creatorUT"
}

JSON Response syntax

Use dark colors for code blocksCopy
{
  "config": {
    "signUpMode": "<sign up mode>",
    "providers": [
      "<social provider1>",
      "<social provider2>",
      "<social provider3>",
      "<social provider4>"
    ]
  }
}

JSON Response example

Use dark colors for code blocksCopy
{
  "config": {
    "signUpMode": "Invitation",
    "providers": [
      "facebook",
      "google",
      "apple",
      "github"
    ]
  }
}

ArcGIS REST APIs

/socialProviders: Social Providers

Was this page helpful?