Skip to main content
POST
Create a SaaS account task on a ticket
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
direction
enum<string>
required

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

Available options:
PROVISION,
DEPROVISION,
UPDATE
employeeId
string

The Primo employee the account is for (id from the employee endpoints). Pass it or onboardingId.

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

The onboarding whose hire the account is for (from getOnboardings), when the employee does not exist yet; only a PROVISION can be opened that way. The account is created for the hire and linked to the employee once created. Pass it or employeeId, not both.

Pattern: ^[a-f\d]{24}$
identityId
string | null

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

Pattern: ^[a-f\d]{24}$
email
string<email> | null

Required for PROVISION, refused for the other directions: the address the account is created with, one of the employee's addresses (emails from getEmployee).

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
groups
object[]
roles
object[]
licenses
object[]
organizationUnits
object[]
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))$
credentialsRecipient
object | null

Who receives the temporary password of an application that generates one (Microsoft Entra, Google Workspace): such an application is refused with CREDENTIALS_RECIPIENT_REQUIRED without it. An application that sets no password does not need it.

Response

default - application/json
id
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 | null
required

The employee the account is for; null on an account opened for the hire of an onboarding before its employee exists

onboardingId
string | null
required

The onboarding whose hire the account is for, when it was opened for one

saasId
string
required
direction
enum<string>
required
Available options:
PROVISION,
DEPROVISION,
UPDATE
identityId
string | null
required
email
string | null
required

The address a PROVISION intent creates the account with

groups
object[]
required
roles
object[]
required
licenses
object[]
required
organizationUnits
object[]
required
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))$