Preview the SaaS accounts the rules grant to a person

curl --request POST \
  --url https://api.getprimo.com/saas/identities/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "teams": [
    "<string>"
  ],
  "jobs": [
    "<string>"
  ],
  "workLocation": "<string>",
  "legalEntity": "<string>",
  "managerFullName": "<string>",
  "employmentType": "<string>",
  "customFields": [
    {
      "customFieldId": "<string>",
      "value": true
    }
  ]
}
'

import requests

url = "https://api.getprimo.com/saas/identities/preview"

payload = {
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "teams": ["<string>"],
    "jobs": ["<string>"],
    "workLocation": "<string>",
    "legalEntity": "<string>",
    "managerFullName": "<string>",
    "employmentType": "<string>",
    "customFields": [
        {
            "customFieldId": "<string>",
            "value": True
        }
    ]
}
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({
    firstName: '<string>',
    lastName: '<string>',
    email: '<string>',
    teams: ['<string>'],
    jobs: ['<string>'],
    workLocation: '<string>',
    legalEntity: '<string>',
    managerFullName: '<string>',
    employmentType: '<string>',
    customFields: [{customFieldId: '<string>', value: true}]
  })
};

fetch('https://api.getprimo.com/saas/identities/preview', 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/preview",
  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([
    'firstName' => '<string>',
    'lastName' => '<string>',
    'email' => '<string>',
    'teams' => [
        '<string>'
    ],
    'jobs' => [
        '<string>'
    ],
    'workLocation' => '<string>',
    'legalEntity' => '<string>',
    'managerFullName' => '<string>',
    'employmentType' => '<string>',
    'customFields' => [
        [
                'customFieldId' => '<string>',
                'value' => true
        ]
    ]
  ]),
  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/preview"

	payload := strings.NewReader("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"<string>\",\n  \"teams\": [\n    \"<string>\"\n  ],\n  \"jobs\": [\n    \"<string>\"\n  ],\n  \"workLocation\": \"<string>\",\n  \"legalEntity\": \"<string>\",\n  \"managerFullName\": \"<string>\",\n  \"employmentType\": \"<string>\",\n  \"customFields\": [\n    {\n      \"customFieldId\": \"<string>\",\n      \"value\": true\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/preview")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"<string>\",\n  \"teams\": [\n    \"<string>\"\n  ],\n  \"jobs\": [\n    \"<string>\"\n  ],\n  \"workLocation\": \"<string>\",\n  \"legalEntity\": \"<string>\",\n  \"managerFullName\": \"<string>\",\n  \"employmentType\": \"<string>\",\n  \"customFields\": [\n    {\n      \"customFieldId\": \"<string>\",\n      \"value\": true\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getprimo.com/saas/identities/preview")

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  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"<string>\",\n  \"teams\": [\n    \"<string>\"\n  ],\n  \"jobs\": [\n    \"<string>\"\n  ],\n  \"workLocation\": \"<string>\",\n  \"legalEntity\": \"<string>\",\n  \"managerFullName\": \"<string>\",\n  \"employmentType\": \"<string>\",\n  \"customFields\": [\n    {\n      \"customFieldId\": \"<string>\",\n      \"value\": true\n    }\n  ]\n}"

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

{
  "data": [
    {
      "saasId": "<string>",
      "saasName": "<string>",
      "groups": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "roles": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "licenses": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "organizationUnits": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ]
    }
  ]
}

Saas

Preview the SaaS accounts the rules grant to a person

Judge a person against the company’s published SaaS rules and return, for each APPROVED application whose rule grants them an account, the groups, roles, licenses and organization units they should get. The same judgement decides what a new hire is preselected for at onboarding and which access gaps an application shows.

The person is described by attributes, not by an id: they do not need to exist in Primo yet, so it answers for a future hire as well as for an employee. For an existing employee, pass what getEmployee and getEmployeeCustomFields return for them — the rules may depend on any of it, custom fields included.

It creates nothing. Each entry carries the saasId and the entitlement ids provisionSaasIdentity takes, so a proposal built from it can be carried out once approved. An application without a published rule, or whose rule does not grant the person, is absent.

EXPENSIVE: one AI judgement per application with a published rule. Call it once per person, never in a loop or across the directory.

POST

saas

identities

preview

Preview the SaaS accounts the rules grant to a person

curl --request POST \
  --url https://api.getprimo.com/saas/identities/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "teams": [
    "<string>"
  ],
  "jobs": [
    "<string>"
  ],
  "workLocation": "<string>",
  "legalEntity": "<string>",
  "managerFullName": "<string>",
  "employmentType": "<string>",
  "customFields": [
    {
      "customFieldId": "<string>",
      "value": true
    }
  ]
}
'

import requests

url = "https://api.getprimo.com/saas/identities/preview"

payload = {
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "teams": ["<string>"],
    "jobs": ["<string>"],
    "workLocation": "<string>",
    "legalEntity": "<string>",
    "managerFullName": "<string>",
    "employmentType": "<string>",
    "customFields": [
        {
            "customFieldId": "<string>",
            "value": True
        }
    ]
}
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({
    firstName: '<string>',
    lastName: '<string>',
    email: '<string>',
    teams: ['<string>'],
    jobs: ['<string>'],
    workLocation: '<string>',
    legalEntity: '<string>',
    managerFullName: '<string>',
    employmentType: '<string>',
    customFields: [{customFieldId: '<string>', value: true}]
  })
};

fetch('https://api.getprimo.com/saas/identities/preview', 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/preview",
  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([
    'firstName' => '<string>',
    'lastName' => '<string>',
    'email' => '<string>',
    'teams' => [
        '<string>'
    ],
    'jobs' => [
        '<string>'
    ],
    'workLocation' => '<string>',
    'legalEntity' => '<string>',
    'managerFullName' => '<string>',
    'employmentType' => '<string>',
    'customFields' => [
        [
                'customFieldId' => '<string>',
                'value' => true
        ]
    ]
  ]),
  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/preview"

	payload := strings.NewReader("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"<string>\",\n  \"teams\": [\n    \"<string>\"\n  ],\n  \"jobs\": [\n    \"<string>\"\n  ],\n  \"workLocation\": \"<string>\",\n  \"legalEntity\": \"<string>\",\n  \"managerFullName\": \"<string>\",\n  \"employmentType\": \"<string>\",\n  \"customFields\": [\n    {\n      \"customFieldId\": \"<string>\",\n      \"value\": true\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/preview")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"<string>\",\n  \"teams\": [\n    \"<string>\"\n  ],\n  \"jobs\": [\n    \"<string>\"\n  ],\n  \"workLocation\": \"<string>\",\n  \"legalEntity\": \"<string>\",\n  \"managerFullName\": \"<string>\",\n  \"employmentType\": \"<string>\",\n  \"customFields\": [\n    {\n      \"customFieldId\": \"<string>\",\n      \"value\": true\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getprimo.com/saas/identities/preview")

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  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"email\": \"<string>\",\n  \"teams\": [\n    \"<string>\"\n  ],\n  \"jobs\": [\n    \"<string>\"\n  ],\n  \"workLocation\": \"<string>\",\n  \"legalEntity\": \"<string>\",\n  \"managerFullName\": \"<string>\",\n  \"employmentType\": \"<string>\",\n  \"customFields\": [\n    {\n      \"customFieldId\": \"<string>\",\n      \"value\": true\n    }\n  ]\n}"

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

{
  "data": [
    {
      "saasId": "<string>",
      "saasName": "<string>",
      "groups": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "roles": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "licenses": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "organizationUnits": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ]
    }
  ]
}

Key: Read Scope: Company

Authorizations

Authorization

string

header

required

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

Body

application/json

firstName

string

First name of the person.

Minimum string length: 1

lastName

string

Last name of the person.

Minimum string length: 1

string

Work email of the person.

Minimum string length: 1

teams

string[]

Names of the teams the person is in, as the company writes them. A team that does not exist in Primo yet is fine.

Minimum string length: 1

jobs

string[]

Job titles of the person. A title that does not exist in Primo yet is fine.

Minimum string length: 1

workLocation

string

Name of the work location, e.g. an office or a city.

Minimum string length: 1

legalEntity

string

Name of the legal entity that employs the person.

Minimum string length: 1

managerFullName

string

Full name of the person's manager.

Minimum string length: 1

employmentType

string

Kind of contract, e.g. permanent, contractor, intern.

Minimum string length: 1

customFields

object[]

The person's employee custom field values. The rules read them by the field's label.

Show child attributes

Response

default - application/json

data

object[]

required

One entry per APPROVED application whose published rule grants the person an account. An application the rules do not grant is absent.

Show child attributes

Getting Started

API Reference

Preview the SaaS accounts the rules grant to a person

Authorizations

Body

Response