Sign in

v1

latestOpenAPI 3.0.32026-08-064799140.5 KB
Users

List all social logins for a user

Returns a list of social logins for a user by given userID.

The list can be sorted and filtered:

  • The sort parameter supports the following fields: providerType and foreignID.
  • The filter parameter supports the following fields: providerType and foreignID.

Refer to the parameter description for more details on sorting in different directions and using the filter with different operators.

get/users/{userID}/socialAccounts

Path parameters

userIDstring required
Example:usr-4693224802260150919

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

Query parameters

sortstring
Example:createdAt:desc

Field and direction to sort results. Use the format fieldName:asc or fieldName:desc.

filter[]string[]

Filter results by specific fields and conditions. Format: <field>:<operator>:<value>. Supported operators include:

  • eq: equals (e.g. email:eq:mail@example\.com matches items where email equals mail@example.com)
  • gt: greater than (e.g. created:gt:2021-01-01T00:00:00 matches items created after Jan 1, 2021)
  • lt: less than (e.g. created:lt:2021-01-01T00:00:00 matches items created before Jan 1, 2021)
pageinteger
Example:1

The page number to retrieve for paginated results.

pageSizeinteger
Example:20

The number of items to return per page. Useful for pagination.

Response

List of social logins.

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"
  }
]