Skip to main content
GET
Get a SaaS by ID
Key: Read 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

Response

default - application/json
id
string
required

The company SaaS application ID (companySaasApplicationId). Pass this value as saasId to the other SaaS endpoints (getSaasById, getSaasIssues, provision/deprovision, …).

name
string
required
approvalStatus
enum<string>
required

Approval status of the SaaS application in your company.

Available options:
TO_REVIEW,
APPROVED,
REJECTED
tags
string[]
required
connectionStatus
enum<string>
required
Available options:
CONNECTED,
DISCONNECTED,
PENDING,
NOT_CONNECTED,
NOT_CONNECTABLE
identitiesCount
integer
required
Required range: 0 <= x <= 9007199254740991
identities
object[]
required
recentEvents
object[]
required

The 20 most synchronization-related recent events for this SaaS integration.

contract
object | null
required

Billing contract currently configured for this SaaS.

finance
object
required

Derived financial metrics computed from the configured contract.

licenses
object[]
required

SaaS license catalog — all available licenses for this SaaS application.

groups
object[]
required

All groups available in this SaaS application. Use id when provisioning.

roles
object[]
required

All roles available in this SaaS application. Use id when provisioning.

organizationUnits
object[]
required

All organization units available in this SaaS application. Use id when provisioning.

rule
object | null
required

Provisioning rule configured for this SaaS, or null if no rule has been authored yet.