Create a SaaS account task on a ticket

curl --request POST \
  --url https://api.getprimo.com/saas/{saasId}/provisioning-intents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "employeeId": "<string>",
  "identityId": "<string>",
  "groups": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "roles": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "licenses": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "organizationUnits": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "parentTicketId": "<string>",
  "scheduleDate": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.getprimo.com/saas/{saasId}/provisioning-intents"

payload = {
    "employeeId": "<string>",
    "identityId": "<string>",
    "groups": [
        {
            "id": "<string>",
            "name": "<string>"
        }
    ],
    "roles": [
        {
            "id": "<string>",
            "name": "<string>"
        }
    ],
    "licenses": [
        {
            "id": "<string>",
            "name": "<string>"
        }
    ],
    "organizationUnits": [
        {
            "id": "<string>",
            "name": "<string>"
        }
    ],
    "parentTicketId": "<string>",
    "scheduleDate": "2023-11-07T05:31:56Z"
}
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({
    employeeId: '<string>',
    identityId: '<string>',
    groups: [{id: '<string>', name: '<string>'}],
    roles: [{id: '<string>', name: '<string>'}],
    licenses: [{id: '<string>', name: '<string>'}],
    organizationUnits: [{id: '<string>', name: '<string>'}],
    parentTicketId: '<string>',
    scheduleDate: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.getprimo.com/saas/{saasId}/provisioning-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/saas/{saasId}/provisioning-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([
    'employeeId' => '<string>',
    'identityId' => '<string>',
    'groups' => [
        [
                'id' => '<string>',
                'name' => '<string>'
        ]
    ],
    'roles' => [
        [
                'id' => '<string>',
                'name' => '<string>'
        ]
    ],
    'licenses' => [
        [
                'id' => '<string>',
                'name' => '<string>'
        ]
    ],
    'organizationUnits' => [
        [
                'id' => '<string>',
                'name' => '<string>'
        ]
    ],
    'parentTicketId' => '<string>',
    'scheduleDate' => '2023-11-07T05:31:56Z'
  ]),
  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/{saasId}/provisioning-intents"

	payload := strings.NewReader("{\n  \"employeeId\": \"<string>\",\n  \"identityId\": \"<string>\",\n  \"groups\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"roles\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"licenses\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"organizationUnits\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"parentTicketId\": \"<string>\",\n  \"scheduleDate\": \"2023-11-07T05:31:56Z\"\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/{saasId}/provisioning-intents")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"employeeId\": \"<string>\",\n  \"identityId\": \"<string>\",\n  \"groups\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"roles\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"licenses\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"organizationUnits\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"parentTicketId\": \"<string>\",\n  \"scheduleDate\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getprimo.com/saas/{saasId}/provisioning-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  \"employeeId\": \"<string>\",\n  \"identityId\": \"<string>\",\n  \"groups\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"roles\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"licenses\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"organizationUnits\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"parentTicketId\": \"<string>\",\n  \"scheduleDate\": \"2023-11-07T05:31:56Z\"\n}"

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

{
  "id": "<string>",
  "taskId": "<string>",
  "ticketId": "<string>",
  "employeeId": "<string>",
  "saasId": "<string>",
  "direction": "PROVISION",
  "identityId": "<string>",
  "groups": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "roles": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "licenses": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "organizationUnits": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "executedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z"
}

Saas

Create a SaaS account task on a ticket

Create, remove or update an employee’s account on a SaaS application as a SAAS_PROVISIONING task on a ticket, so the account can be scheduled, cancelled and completed like any task. Pass the untyped ticket the work belongs to, such as an onboarding ticket, as parentTicketId; without one Primo opens a ticket for the employee to hold the task. createTicket and createTask cannot make a typed task.

With an API integration the account is carried out by Primo, at once or on scheduleDate, and the task completes itself. Without one the task waits for an admin, who creates the account by hand and marks the task done, which records the account in Primo. Cancelling the task cancels the account change.

Use provisionSaasIdentity or deprovisionSaasIdentity for an account change nobody needs to track on a ticket. Returns the intent id, its taskId and the ticketId holding it. Entitlements are { id, name } pairs from getSaasById.

Refused with PARENT_TICKET_IS_TYPED or PARENT_TICKET_IS_A_TASK (pass the untyped ticket instead), PARENT_TICKET_NOT_FOUND, EMPLOYEE_NOT_FOUND, CREDENTIALS_RECIPIENT_REQUIRED for an application that generates a password (create that account from the cockpit), SAAS_APPLICATION_USER_REQUIRED for an UPDATE without identityId, and SAAS_APPLICATION_USER_NOT_FOUND for an identityId that belongs to another employee or application.

POST

saas

{saasId}

provisioning-intents

Create a SaaS account task on a ticket

curl --request POST \
  --url https://api.getprimo.com/saas/{saasId}/provisioning-intents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "employeeId": "<string>",
  "identityId": "<string>",
  "groups": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "roles": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "licenses": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "organizationUnits": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "parentTicketId": "<string>",
  "scheduleDate": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.getprimo.com/saas/{saasId}/provisioning-intents"

payload = {
    "employeeId": "<string>",
    "identityId": "<string>",
    "groups": [
        {
            "id": "<string>",
            "name": "<string>"
        }
    ],
    "roles": [
        {
            "id": "<string>",
            "name": "<string>"
        }
    ],
    "licenses": [
        {
            "id": "<string>",
            "name": "<string>"
        }
    ],
    "organizationUnits": [
        {
            "id": "<string>",
            "name": "<string>"
        }
    ],
    "parentTicketId": "<string>",
    "scheduleDate": "2023-11-07T05:31:56Z"
}
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({
    employeeId: '<string>',
    identityId: '<string>',
    groups: [{id: '<string>', name: '<string>'}],
    roles: [{id: '<string>', name: '<string>'}],
    licenses: [{id: '<string>', name: '<string>'}],
    organizationUnits: [{id: '<string>', name: '<string>'}],
    parentTicketId: '<string>',
    scheduleDate: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.getprimo.com/saas/{saasId}/provisioning-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/saas/{saasId}/provisioning-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([
    'employeeId' => '<string>',
    'identityId' => '<string>',
    'groups' => [
        [
                'id' => '<string>',
                'name' => '<string>'
        ]
    ],
    'roles' => [
        [
                'id' => '<string>',
                'name' => '<string>'
        ]
    ],
    'licenses' => [
        [
                'id' => '<string>',
                'name' => '<string>'
        ]
    ],
    'organizationUnits' => [
        [
                'id' => '<string>',
                'name' => '<string>'
        ]
    ],
    'parentTicketId' => '<string>',
    'scheduleDate' => '2023-11-07T05:31:56Z'
  ]),
  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/{saasId}/provisioning-intents"

	payload := strings.NewReader("{\n  \"employeeId\": \"<string>\",\n  \"identityId\": \"<string>\",\n  \"groups\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"roles\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"licenses\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"organizationUnits\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"parentTicketId\": \"<string>\",\n  \"scheduleDate\": \"2023-11-07T05:31:56Z\"\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/{saasId}/provisioning-intents")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"employeeId\": \"<string>\",\n  \"identityId\": \"<string>\",\n  \"groups\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"roles\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"licenses\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"organizationUnits\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"parentTicketId\": \"<string>\",\n  \"scheduleDate\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getprimo.com/saas/{saasId}/provisioning-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  \"employeeId\": \"<string>\",\n  \"identityId\": \"<string>\",\n  \"groups\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"roles\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"licenses\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"organizationUnits\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"parentTicketId\": \"<string>\",\n  \"scheduleDate\": \"2023-11-07T05:31:56Z\"\n}"

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

{
  "id": "<string>",
  "taskId": "<string>",
  "ticketId": "<string>",
  "employeeId": "<string>",
  "saasId": "<string>",
  "direction": "PROVISION",
  "identityId": "<string>",
  "groups": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "roles": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "licenses": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "organizationUnits": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "executedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z"
}

Key: Write Scope: Company

Authorizations

Authorization

string

header

required

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

Path Parameters

saasId

string

required

Body

application/json

employeeId

string

required

The Primo employee the account is for (id from the employee endpoints).

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

direction

enum<string>

required

PROVISION creates the account, DEPROVISION removes it, UPDATE re-applies the entitlements on it.

Available options:

PROVISION,

DEPROVISION,

UPDATE

identityId

string | null

The SaaS identity to update or remove (from getEmployeeSaasIdentities). Required for UPDATE.

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

groups

object[]

Show child attributes

roles

object[]

Show child attributes

licenses

object[]

Show child attributes

organizationUnits

object[]

Show child attributes

parentTicketId

string | null

The untyped ticket the work belongs to, such as the onboarding ticket. Omit it and Primo opens one.

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

scheduleDate

string<date-time> | null

Creates the task SCHEDULED: an integrated application is provisioned when it wakes on this date, not now.

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))$

Response

default - application/json

string

required

Intent id

taskId

string | null

required

The SAAS_PROVISIONING task that tracks the account

ticketId

string

required

The ticket holding that task: the parentTicketId sent, or the one Primo opened

employeeId

string

required

saasId

string

required

direction

enum<string>

required

Available options:

PROVISION,

DEPROVISION,

UPDATE

identityId

string | null

required

groups

object[]

required

Show child attributes

roles

object[]

required

Show child attributes

licenses

object[]

required

Show child attributes

organizationUnits

object[]

required

Show child attributes

executedAt

string<date-time> | null

required

When Primo carried the account out; null while it waits on its date or on the admin

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))$

createdAt

string<date-time>

required

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))$

Get started

API Reference

Create a SaaS account task on a ticket

Authorizations

Path Parameters

Body

Response