Sign in

v1

latestOpenAPI 3.0.32026-08-064799140.5 KB
Users

Create a social login for a user

Creates a new social login for a user by given userID. Social logins are used to authenticate users with third-party providers like Google, Microsoft, or GitHub.

You can set up social logins in the Developer Panel or consult the Documentation for more details.

post/users/{userID}/socialAccounts

Path parameters

userIDstring required
Example:usr-4693224802260150919

Unique identifier of the user. Format: usr-<number>.

Request body

providerType'google' | 'microsoft' | 'github' required

Type of the social provider.

identifierValuestring required

Login identifier of the user (here email address).

foreignIDstring required

Unique identifier of the user in the social provider.

avatarURLstring required

URL of the avatar of the user in the social provider.

fullNamestring required

Full name of the user in the social provider.

Example request

{
  "identifierValue": "jane@doe.com",
  "foreignID": "53150919",
  "avatarURL": "https://avatars.githubusercontent.com/u/53150919?v=4",
  "fullName": "Jane Doe"
}

Response

Social login has been created.

socialAccountIDstring required

Unique identifier of the social account.

providerTypestring required

Type of the social provider.

identifierValuestring required

Login identifier of the user (here email address).

userIDstring required

Unique identifier of the user.

foreignIDstring required

Unique identifier of the user in the social provider.

avatarURLstring required

URL of the avatar of the user in the social provider.

fullNamestring required

Full name of the user in the social provider.

Example response

{
  "socialAccountID": "soc-6060375336139150919",
  "providerType": "github",
  "identifierValue": "jane@doe.com",
  "userID": "usr-4693224802260150919",
  "foreignID": "53150919",
  "avatarURL": "https://avatars.githubusercontent.com/u/53150919?v=4",
  "fullName": "Jane Doe"
}