ListLinkSuggestions
curl --request POST \
--url https://developer.synq.io/api/entities/platform-users/v1alpha/link-suggestions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"members": [
{
"userId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"identities": [
"<string>"
]
}
],
"platformUserIds": [
"<string>"
],
"pagination": {
"cursor": "<string>",
"pageSize": 1
}
}
'import requests
url = "https://developer.synq.io/api/entities/platform-users/v1alpha/link-suggestions"
payload = {
"members": [
{
"userId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"identities": ["<string>"]
}
],
"platformUserIds": ["<string>"],
"pagination": {
"cursor": "<string>",
"pageSize": 1
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
members: [
{
userId: '<string>',
firstName: '<string>',
lastName: '<string>',
email: '<string>',
identities: ['<string>']
}
],
platformUserIds: ['<string>'],
pagination: {cursor: '<string>', pageSize: 1}
})
};
fetch('https://developer.synq.io/api/entities/platform-users/v1alpha/link-suggestions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://developer.synq.io/api/entities/platform-users/v1alpha/link-suggestions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'members' => [
[
'userId' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>',
'email' => '<string>',
'identities' => [
'<string>'
]
]
],
'platformUserIds' => [
'<string>'
],
'pagination' => [
'cursor' => '<string>',
'pageSize' => 1
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://developer.synq.io/api/entities/platform-users/v1alpha/link-suggestions"
payload := strings.NewReader("{\n \"members\": [\n {\n \"userId\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"identities\": [\n \"<string>\"\n ]\n }\n ],\n \"platformUserIds\": [\n \"<string>\"\n ],\n \"pagination\": {\n \"cursor\": \"<string>\",\n \"pageSize\": 1\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://developer.synq.io/api/entities/platform-users/v1alpha/link-suggestions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"members\": [\n {\n \"userId\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"identities\": [\n \"<string>\"\n ]\n }\n ],\n \"platformUserIds\": [\n \"<string>\"\n ],\n \"pagination\": {\n \"cursor\": \"<string>\",\n \"pageSize\": 1\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.synq.io/api/entities/platform-users/v1alpha/link-suggestions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"members\": [\n {\n \"userId\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"identities\": [\n \"<string>\"\n ]\n }\n ],\n \"platformUserIds\": [\n \"<string>\"\n ],\n \"pagination\": {\n \"cursor\": \"<string>\",\n \"pageSize\": 1\n }\n}"
response = http.request(request)
puts response.read_body{
"suggestions": [
{
"platformUserId": "<string>",
"login": "<string>",
"platform": "DATA_PLATFORM_TYPE_UNSPECIFIED",
"platformRootEntityId": "<string>",
"userIdentity": "<string>",
"evidence": "LINK_EVIDENCE_UNSPECIFIED",
"ambiguous": true
}
],
"pageInfo": {
"totalCount": 123,
"count": 123,
"lastId": "<string>"
}
}synq.entities.platformusers.v1alpha.PlatformUsersService
ListLinkSuggestions
Suggest which workspace member each unclassified login may belong to, by matching the login
against the members the caller passes. Accept a suggestion with synq.users.v1
UsersService.UpsertUserAliases. A login already linked is skipped only when the caller lists its
"platform_user:<id>" among a member's identities.
POST
/
api
/
entities
/
platform-users
/
v1alpha
/
link-suggestions
ListLinkSuggestions
curl --request POST \
--url https://developer.synq.io/api/entities/platform-users/v1alpha/link-suggestions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"members": [
{
"userId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"identities": [
"<string>"
]
}
],
"platformUserIds": [
"<string>"
],
"pagination": {
"cursor": "<string>",
"pageSize": 1
}
}
'import requests
url = "https://developer.synq.io/api/entities/platform-users/v1alpha/link-suggestions"
payload = {
"members": [
{
"userId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"identities": ["<string>"]
}
],
"platformUserIds": ["<string>"],
"pagination": {
"cursor": "<string>",
"pageSize": 1
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
members: [
{
userId: '<string>',
firstName: '<string>',
lastName: '<string>',
email: '<string>',
identities: ['<string>']
}
],
platformUserIds: ['<string>'],
pagination: {cursor: '<string>', pageSize: 1}
})
};
fetch('https://developer.synq.io/api/entities/platform-users/v1alpha/link-suggestions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://developer.synq.io/api/entities/platform-users/v1alpha/link-suggestions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'members' => [
[
'userId' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>',
'email' => '<string>',
'identities' => [
'<string>'
]
]
],
'platformUserIds' => [
'<string>'
],
'pagination' => [
'cursor' => '<string>',
'pageSize' => 1
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://developer.synq.io/api/entities/platform-users/v1alpha/link-suggestions"
payload := strings.NewReader("{\n \"members\": [\n {\n \"userId\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"identities\": [\n \"<string>\"\n ]\n }\n ],\n \"platformUserIds\": [\n \"<string>\"\n ],\n \"pagination\": {\n \"cursor\": \"<string>\",\n \"pageSize\": 1\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://developer.synq.io/api/entities/platform-users/v1alpha/link-suggestions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"members\": [\n {\n \"userId\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"identities\": [\n \"<string>\"\n ]\n }\n ],\n \"platformUserIds\": [\n \"<string>\"\n ],\n \"pagination\": {\n \"cursor\": \"<string>\",\n \"pageSize\": 1\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.synq.io/api/entities/platform-users/v1alpha/link-suggestions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"members\": [\n {\n \"userId\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"identities\": [\n \"<string>\"\n ]\n }\n ],\n \"platformUserIds\": [\n \"<string>\"\n ],\n \"pagination\": {\n \"cursor\": \"<string>\",\n \"pageSize\": 1\n }\n}"
response = http.request(request)
puts response.read_body{
"suggestions": [
{
"platformUserId": "<string>",
"login": "<string>",
"platform": "DATA_PLATFORM_TYPE_UNSPECIFIED",
"platformRootEntityId": "<string>",
"userIdentity": "<string>",
"evidence": "LINK_EVIDENCE_UNSPECIFIED",
"ambiguous": true
}
],
"pageInfo": {
"totalCount": 123,
"count": 123,
"lastId": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
The members to match, as synq.users.v1 UsersService.ListUsers returns them.
Required array length:
1 - 5000 elementsShow child attributes
Show child attributes
Only these logins. Empty considers every login.
Maximum array length:
1000Required string length:
1 - 2048Without a page size every suggestion is returned.
Show child attributes
Show child attributes