Link SaaS identities to the employees who own them

curl --request POST \
  --url https://api.getprimo.com/saas-identities/batch-link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "links": [
    {
      "saasApplicationUserId": "<string>",
      "employeeId": "<string>"
    }
  ]
}
'

import requests

url = "https://api.getprimo.com/saas-identities/batch-link"

payload = { "links": [
        {
            "saasApplicationUserId": "<string>",
            "employeeId": "<string>"
        }
    ] }
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({links: [{saasApplicationUserId: '<string>', employeeId: '<string>'}]})
};

fetch('https://api.getprimo.com/saas-identities/batch-link', 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://api.getprimo.com/saas-identities/batch-link",
  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([
    'links' => [
        [
                'saasApplicationUserId' => '<string>',
                'employeeId' => '<string>'
        ]
    ]
  ]),
  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://api.getprimo.com/saas-identities/batch-link"

	payload := strings.NewReader("{\n  \"links\": [\n    {\n      \"saasApplicationUserId\": \"<string>\",\n      \"employeeId\": \"<string>\"\n    }\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://api.getprimo.com/saas-identities/batch-link")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"links\": [\n    {\n      \"saasApplicationUserId\": \"<string>\",\n      \"employeeId\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getprimo.com/saas-identities/batch-link")

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  \"links\": [\n    {\n      \"saasApplicationUserId\": \"<string>\",\n      \"employeeId\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "successCount": 0,
  "failureCount": 0,
  "results": [
    {
      "status": "ok",
      "saasApplicationUserId": "<string>",
      "employeeId": "<string>",
      "errorCode": "<string>",
      "message": "<string>"
    }
  ]
}

Saas

Link SaaS identities to the employees who own them

Link existing SaaS identities (accounts already on an application) to the employees who own them, up to 100 identity → employee pairs per call. Primo links an account to an employee by itself only when the account email equals the employee email; this links the accounts it could not match, such as an alias (firstname.lastname@) of an employee whose HR email is flastname@.

The account keeps its own email, becomes an employee account and leaves the “To link” list. An identity already linked to another employee moves to the one given. A later integration sync keeps the link. Nothing changes in the application itself.

Read the identities to link from getUnlinkedSaasIdentities (its id) and the employees from getEmployees (its id). To record an account Primo does not know yet, use createSaasIdentity instead; to have an admin create a new account, use provisionSaasIdentity.

Writes are independent and best-effort: the call returns 200 with a results manifest reporting ok / error per item — always inspect results rather than relying on the HTTP status to detect partial failures.

POST

saas-identities

batch-link

Link SaaS identities to the employees who own them

curl --request POST \
  --url https://api.getprimo.com/saas-identities/batch-link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "links": [
    {
      "saasApplicationUserId": "<string>",
      "employeeId": "<string>"
    }
  ]
}
'

import requests

url = "https://api.getprimo.com/saas-identities/batch-link"

payload = { "links": [
        {
            "saasApplicationUserId": "<string>",
            "employeeId": "<string>"
        }
    ] }
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({links: [{saasApplicationUserId: '<string>', employeeId: '<string>'}]})
};

fetch('https://api.getprimo.com/saas-identities/batch-link', 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://api.getprimo.com/saas-identities/batch-link",
  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([
    'links' => [
        [
                'saasApplicationUserId' => '<string>',
                'employeeId' => '<string>'
        ]
    ]
  ]),
  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://api.getprimo.com/saas-identities/batch-link"

	payload := strings.NewReader("{\n  \"links\": [\n    {\n      \"saasApplicationUserId\": \"<string>\",\n      \"employeeId\": \"<string>\"\n    }\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://api.getprimo.com/saas-identities/batch-link")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"links\": [\n    {\n      \"saasApplicationUserId\": \"<string>\",\n      \"employeeId\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getprimo.com/saas-identities/batch-link")

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  \"links\": [\n    {\n      \"saasApplicationUserId\": \"<string>\",\n      \"employeeId\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "successCount": 0,
  "failureCount": 0,
  "results": [
    {
      "status": "ok",
      "saasApplicationUserId": "<string>",
      "employeeId": "<string>",
      "errorCode": "<string>",
      "message": "<string>"
    }
  ]
}

Key: Write Scope: Company

Authorizations

Authorization

string

header

required

Use your Primo API key in the Authorization header as Bearer <API_KEY>.

Body

application/json

links

object[]

required

The identity → employee pairs to link. Each identity may appear at most once and up to 100 pairs per call. Writes are best-effort: inspect the per-item results to learn which succeeded — the HTTP status is 200 even when some items fail.

Required array length: 1 - 100 elements

Show child attributes

Response

default - application/json

successCount

integer

required

Number of identities linked successfully.

Required range: -9007199254740991 <= x <= 9007199254740991

failureCount

integer

required

Number of identities that failed.

Required range: -9007199254740991 <= x <= 9007199254740991

results

object[]

required

Per-item outcome, in the same order as the input links.

Show child attributes

Get started

API Reference

Link SaaS identities to the employees who own them

Authorizations

Body

Response