Create an offboarding access selection intent

curl --request POST \
  --url https://api.getprimo.com/offboarding-access-selection-intents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "offboardingId": "<string>",
  "idps": [
    {
      "companySaasApplicationId": "<string>",
      "saasApplicationUserId": "<string>",
      "selected": true,
      "fileTransferTarget": {
        "employeeId": "<string>"
      },
      "emailForwardingTarget": {
        "employeeId": "<string>"
      }
    }
  ],
  "apps": [
    {
      "companySaasApplicationId": "<string>",
      "saasApplicationUserId": "<string>",
      "selected": true,
      "keptByRuleReason": "<string>"
    }
  ],
  "parentTicketId": "<string>"
}
'

import requests

url = "https://api.getprimo.com/offboarding-access-selection-intents"

payload = {
    "offboardingId": "<string>",
    "idps": [
        {
            "companySaasApplicationId": "<string>",
            "saasApplicationUserId": "<string>",
            "selected": True,
            "fileTransferTarget": { "employeeId": "<string>" },
            "emailForwardingTarget": { "employeeId": "<string>" }
        }
    ],
    "apps": [
        {
            "companySaasApplicationId": "<string>",
            "saasApplicationUserId": "<string>",
            "selected": True,
            "keptByRuleReason": "<string>"
        }
    ],
    "parentTicketId": "<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({
    offboardingId: '<string>',
    idps: [
      {
        companySaasApplicationId: '<string>',
        saasApplicationUserId: '<string>',
        selected: true,
        fileTransferTarget: {employeeId: '<string>'},
        emailForwardingTarget: {employeeId: '<string>'}
      }
    ],
    apps: [
      {
        companySaasApplicationId: '<string>',
        saasApplicationUserId: '<string>',
        selected: true,
        keptByRuleReason: '<string>'
      }
    ],
    parentTicketId: '<string>'
  })
};

fetch('https://api.getprimo.com/offboarding-access-selection-intents', 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/offboarding-access-selection-intents",
  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([
    'offboardingId' => '<string>',
    'idps' => [
        [
                'companySaasApplicationId' => '<string>',
                'saasApplicationUserId' => '<string>',
                'selected' => true,
                'fileTransferTarget' => [
                                'employeeId' => '<string>'
                ],
                'emailForwardingTarget' => [
                                'employeeId' => '<string>'
                ]
        ]
    ],
    'apps' => [
        [
                'companySaasApplicationId' => '<string>',
                'saasApplicationUserId' => '<string>',
                'selected' => true,
                'keptByRuleReason' => '<string>'
        ]
    ],
    'parentTicketId' => '<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/offboarding-access-selection-intents"

	payload := strings.NewReader("{\n  \"offboardingId\": \"<string>\",\n  \"idps\": [\n    {\n      \"companySaasApplicationId\": \"<string>\",\n      \"saasApplicationUserId\": \"<string>\",\n      \"selected\": true,\n      \"fileTransferTarget\": {\n        \"employeeId\": \"<string>\"\n      },\n      \"emailForwardingTarget\": {\n        \"employeeId\": \"<string>\"\n      }\n    }\n  ],\n  \"apps\": [\n    {\n      \"companySaasApplicationId\": \"<string>\",\n      \"saasApplicationUserId\": \"<string>\",\n      \"selected\": true,\n      \"keptByRuleReason\": \"<string>\"\n    }\n  ],\n  \"parentTicketId\": \"<string>\"\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/offboarding-access-selection-intents")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"offboardingId\": \"<string>\",\n  \"idps\": [\n    {\n      \"companySaasApplicationId\": \"<string>\",\n      \"saasApplicationUserId\": \"<string>\",\n      \"selected\": true,\n      \"fileTransferTarget\": {\n        \"employeeId\": \"<string>\"\n      },\n      \"emailForwardingTarget\": {\n        \"employeeId\": \"<string>\"\n      }\n    }\n  ],\n  \"apps\": [\n    {\n      \"companySaasApplicationId\": \"<string>\",\n      \"saasApplicationUserId\": \"<string>\",\n      \"selected\": true,\n      \"keptByRuleReason\": \"<string>\"\n    }\n  ],\n  \"parentTicketId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getprimo.com/offboarding-access-selection-intents")

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  \"offboardingId\": \"<string>\",\n  \"idps\": [\n    {\n      \"companySaasApplicationId\": \"<string>\",\n      \"saasApplicationUserId\": \"<string>\",\n      \"selected\": true,\n      \"fileTransferTarget\": {\n        \"employeeId\": \"<string>\"\n      },\n      \"emailForwardingTarget\": {\n        \"employeeId\": \"<string>\"\n      }\n    }\n  ],\n  \"apps\": [\n    {\n      \"companySaasApplicationId\": \"<string>\",\n      \"saasApplicationUserId\": \"<string>\",\n      \"selected\": true,\n      \"keptByRuleReason\": \"<string>\"\n    }\n  ],\n  \"parentTicketId\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "taskId": "<string>",
  "ticketId": "<string>",
  "offboardingId": "<string>",
  "executedAt": "2023-11-07T05:31:56Z",
  "idps": [
    {
      "companySaasApplicationId": "<string>",
      "saasApplicationUserId": "<string>",
      "selected": true,
      "accountAction": "SUSPEND",
      "fileTransferTarget": {
        "type": "MANAGER",
        "employeeId": "<string>"
      },
      "emailForwardingTarget": {
        "type": "MANAGER",
        "employeeId": "<string>"
      }
    }
  ],
  "apps": [
    {
      "companySaasApplicationId": "<string>",
      "saasApplicationUserId": "<string>",
      "selected": true,
      "keptByRuleReason": "<string>"
    }
  ]
}

Offboardings

Create an offboarding access selection intent

Create the OFFBOARDING_ACCESS_SELECTION task of an offboarding: which of the leaver accounts are removed. Left out, the selection lists every account of the leaver, checked unless the published SaaS rule keeps it. idps are the email provider accounts (Google Workspace, Microsoft 365): what happens to the account (accountAction) and who receives its files and emails; apps are the other SaaS accounts. An entry with selected: false is kept. From getEmployeeSaasIdentities of the leaver: saasId is the companySaasApplicationId, identityId the saasApplicationUserId. Returns the intent id, its taskId and the ticketId holding it. The task cannot be marked done by hand: updateTaskStatus refuses it with TaskLockedByTypeError, and it completes when the intent executes. The offboarding opens this task itself (createOffboarding); its intentId is on the task (getTicket). Create one only for a step the offboarding did not open. createTicket and createTask cannot make a typed task. Refused with OFFBOARDING_NOT_FOUND, PARENT_TICKET_NOT_FOUND, PARENT_TICKET_IS_TYPED or PARENT_TICKET_IS_A_TASK (pass the untyped ticket instead), OFFBOARDING_NOT_OPEN, ACCOUNT_NOT_HELD_BY_LEAVER, IDP_NOT_EMAIL_PROVIDER, APP_IS_EMAIL_PROVIDER, DEPROVISIONING_STRATEGY_NOT_AVAILABLE, TRANSFER_TARGET_NOT_FOUND.

POST

offboarding-access-selection-intents

curl --request POST \
  --url https://api.getprimo.com/offboarding-access-selection-intents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "offboardingId": "<string>",
  "idps": [
    {
      "companySaasApplicationId": "<string>",
      "saasApplicationUserId": "<string>",
      "selected": true,
      "fileTransferTarget": {
        "employeeId": "<string>"
      },
      "emailForwardingTarget": {
        "employeeId": "<string>"
      }
    }
  ],
  "apps": [
    {
      "companySaasApplicationId": "<string>",
      "saasApplicationUserId": "<string>",
      "selected": true,
      "keptByRuleReason": "<string>"
    }
  ],
  "parentTicketId": "<string>"
}
'

import requests

url = "https://api.getprimo.com/offboarding-access-selection-intents"

payload = {
    "offboardingId": "<string>",
    "idps": [
        {
            "companySaasApplicationId": "<string>",
            "saasApplicationUserId": "<string>",
            "selected": True,
            "fileTransferTarget": { "employeeId": "<string>" },
            "emailForwardingTarget": { "employeeId": "<string>" }
        }
    ],
    "apps": [
        {
            "companySaasApplicationId": "<string>",
            "saasApplicationUserId": "<string>",
            "selected": True,
            "keptByRuleReason": "<string>"
        }
    ],
    "parentTicketId": "<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({
    offboardingId: '<string>',
    idps: [
      {
        companySaasApplicationId: '<string>',
        saasApplicationUserId: '<string>',
        selected: true,
        fileTransferTarget: {employeeId: '<string>'},
        emailForwardingTarget: {employeeId: '<string>'}
      }
    ],
    apps: [
      {
        companySaasApplicationId: '<string>',
        saasApplicationUserId: '<string>',
        selected: true,
        keptByRuleReason: '<string>'
      }
    ],
    parentTicketId: '<string>'
  })
};

fetch('https://api.getprimo.com/offboarding-access-selection-intents', 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/offboarding-access-selection-intents",
  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([
    'offboardingId' => '<string>',
    'idps' => [
        [
                'companySaasApplicationId' => '<string>',
                'saasApplicationUserId' => '<string>',
                'selected' => true,
                'fileTransferTarget' => [
                                'employeeId' => '<string>'
                ],
                'emailForwardingTarget' => [
                                'employeeId' => '<string>'
                ]
        ]
    ],
    'apps' => [
        [
                'companySaasApplicationId' => '<string>',
                'saasApplicationUserId' => '<string>',
                'selected' => true,
                'keptByRuleReason' => '<string>'
        ]
    ],
    'parentTicketId' => '<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/offboarding-access-selection-intents"

	payload := strings.NewReader("{\n  \"offboardingId\": \"<string>\",\n  \"idps\": [\n    {\n      \"companySaasApplicationId\": \"<string>\",\n      \"saasApplicationUserId\": \"<string>\",\n      \"selected\": true,\n      \"fileTransferTarget\": {\n        \"employeeId\": \"<string>\"\n      },\n      \"emailForwardingTarget\": {\n        \"employeeId\": \"<string>\"\n      }\n    }\n  ],\n  \"apps\": [\n    {\n      \"companySaasApplicationId\": \"<string>\",\n      \"saasApplicationUserId\": \"<string>\",\n      \"selected\": true,\n      \"keptByRuleReason\": \"<string>\"\n    }\n  ],\n  \"parentTicketId\": \"<string>\"\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/offboarding-access-selection-intents")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"offboardingId\": \"<string>\",\n  \"idps\": [\n    {\n      \"companySaasApplicationId\": \"<string>\",\n      \"saasApplicationUserId\": \"<string>\",\n      \"selected\": true,\n      \"fileTransferTarget\": {\n        \"employeeId\": \"<string>\"\n      },\n      \"emailForwardingTarget\": {\n        \"employeeId\": \"<string>\"\n      }\n    }\n  ],\n  \"apps\": [\n    {\n      \"companySaasApplicationId\": \"<string>\",\n      \"saasApplicationUserId\": \"<string>\",\n      \"selected\": true,\n      \"keptByRuleReason\": \"<string>\"\n    }\n  ],\n  \"parentTicketId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getprimo.com/offboarding-access-selection-intents")

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  \"offboardingId\": \"<string>\",\n  \"idps\": [\n    {\n      \"companySaasApplicationId\": \"<string>\",\n      \"saasApplicationUserId\": \"<string>\",\n      \"selected\": true,\n      \"fileTransferTarget\": {\n        \"employeeId\": \"<string>\"\n      },\n      \"emailForwardingTarget\": {\n        \"employeeId\": \"<string>\"\n      }\n    }\n  ],\n  \"apps\": [\n    {\n      \"companySaasApplicationId\": \"<string>\",\n      \"saasApplicationUserId\": \"<string>\",\n      \"selected\": true,\n      \"keptByRuleReason\": \"<string>\"\n    }\n  ],\n  \"parentTicketId\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "taskId": "<string>",
  "ticketId": "<string>",
  "offboardingId": "<string>",
  "executedAt": "2023-11-07T05:31:56Z",
  "idps": [
    {
      "companySaasApplicationId": "<string>",
      "saasApplicationUserId": "<string>",
      "selected": true,
      "accountAction": "SUSPEND",
      "fileTransferTarget": {
        "type": "MANAGER",
        "employeeId": "<string>"
      },
      "emailForwardingTarget": {
        "type": "MANAGER",
        "employeeId": "<string>"
      }
    }
  ],
  "apps": [
    {
      "companySaasApplicationId": "<string>",
      "saasApplicationUserId": "<string>",
      "selected": true,
      "keptByRuleReason": "<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

offboardingId

string

required

The offboarding this step belongs to, from getOffboardings

Pattern: ^[a-f\d]{24}$

idps

object[] | null

The email provider accounts (Google Workspace, Microsoft 365)

Show child attributes

apps

object[] | null

The other SaaS accounts

Show child attributes

parentTicketId

string | null

The ticket to hold the task. Defaults to the offboarding ticket; never a typed task.

Pattern: ^[a-f\d]{24}$

Response

default - application/json

string

required

Intent id, to pass to its update and execute tools

taskId

string | null

required

The typed task that tracks this step

ticketId

string | null

required

The ticket holding that task, usually the offboarding ticket. Null if it could not be read back.

offboardingId

string

required

executedAt

string<date-time> | null

required

When the intent executed; null until then

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

idps

object[]

required

Show child attributes

apps

object[]

required

Show child attributes

Get started

API Reference

Create an offboarding access selection intent

Authorizations

Body

Response