SaaS: Subscriptions API (1.0.0)

Download OpenAPI specification:Download

URL: https://www.snowsoftware.com

API for interacting with SaaS Subscriptions.

Subscriptions

Get subscription insight users

Returns a collection of users for a subscription insight.

Authorizations:

bearerAuthbearerAuth

path Parameters

subscriptionId required	string Example: a7a75b83-2690-4cc9-b652-a0fbe93dba4a The unique ID of the subscription.
insightRuleId required	string Example: 577ee610-95f2-4883-abaa-d702e73c3a10 The unique ID of the insight.

query Parameters

page_size	integer <= 1000 Default: 100 The maximum number of items in the response.
page_number	integer <int64> Default: 1 The page number.
filter	string Example: filter=?filter=field1 -eq "abc" For more information on the available operators and which data types those operators work on, see Filter API call results.
sort	string Example: sort=?sort=field1:asc For more information on sorting capability and examples, see Sort API call results.

Responses

Response samples

200
400
404
500

Content type

application/json

{"items": [{"country": "Japan",
"createdDate": "2024-05-25T00:00:00Z",
"department": "Engineering",
"discoveryTypes": [1,
2
],
"displayName": "John Doe",
"email": "john.doe@organization.com",
"id": "2f86b198-04f3-4770-ad08-b32518206da0",
"isEnabled": true,
"isInReview": true,
"isOnline": true,
"isQualified": true,
"lastActive": "2024-06-28T00:00:00Z",
"licenseCount": 5,
"potentialSavings": 500,
"status": "Active",
"userCostPerMonth": 1000,
"username": "john.doe_1@org.com",
"details": [{"lastActive": "2019-08-24T14:15:22Z",
"subscriptionId": "1519f3e3-7e5a-466b-8a86-63ed2776f819",
"subscriptionName": "Microsoft 365 E5",
"applicationId": "3519f3f3-7e5a-e66b-8a86-63ed2776f618",
"applicationName": "Microsoft Power BI"
}
]
}
],
"pagination": {"page_size": 100,
"page_number": 1,
"total_pages": 1,
"total_items": 1
}
}

Delete subscription users

Removes the given one or more assigned users from a subscription.

Authorizations:

bearerAuthbearerAuth

path Parameters

subscriptionId required	string Example: a7a75b83-2690-4cc9-b652-a0fbe93dba4a The unique ID of the subscription.
userIds required	Array of arrays Example: d69809c5-e4c0-4d22-be9f-f541f6a265ee,f90eeb4b-614b-432c-b506-4203a2db60c8 The unique ID of the of the subscriptions.

Responses

Response samples

400
404
500

Content type

application/json

{"error": {"code": 400,
"message": "Filter field name needs to be formatted as a string."
}
}

Get subscription users

Returns a collection of users assigned to a subscription.

Authorizations:

bearerAuthbearerAuth

path Parameters

subscriptionId

required

string

Example: a7a75b83-2690-4cc9-b652-a0fbe93dba4a

The unique ID of the user.

query Parameters

page_size	integer <= 1000 Default: 100 The maximum number of items in the response.
page_number	integer <int64> Default: 1 The page number.

Responses

Response samples

200
400
404
500

Content type

application/json

{"pagination": {"page_size": 100,
"page_number": 1,
"total_pages": 1,
"total_items": 1
},
"items": [{"country": "Japan",
"createdDate": "2024-05-25T00:00:00Z",
"department": "Engineering",
"discoveryTypes": [1,
2
],
"displayName": "John Doe",
"email": "john.doe@organization.com",
"id": "2f86b198-04f3-4770-ad08-b32518206da0",
"isEnabled": true,
"isInReview": true,
"isOnline": true,
"isQualified": true,
"lastActive": "2024-06-28T00:00:00Z",
"licenseCount": 5,
"potentialSavings": 500,
"status": "Active",
"userCostPerMonth": 1000,
"username": "john.doe_1@org.com"
}
]
}