The Applications API from Snow Software — 10 operation(s) for applications.
openapi: 3.0.3
info:
title: 'SAM: Computers Applications API'
description: API for interacting with computers.
contact:
name: Flexera
url: https://www.flexera.com
version: 1.0.0
servers:
- url: https://{region}.snowsoftware.io
variables:
region:
enum:
- westeurope
- australiasoutheast
- eastus2
- uksouth
default: westeurope
tags:
- name: Applications
paths:
/api/saas/consolidated-view/v1/applications:
get:
summary: Get Applications
description: Returns the details of a list of applications.
operationId: getApplications
tags:
- Applications
parameters:
- $ref: '#/components/parameters/PageNumberQuery'
- $ref: '#/components/parameters/PageSizeQuery'
- $ref: '#/components/parameters/FilterQuery'
- $ref: '#/components/parameters/SortQuery'
responses:
'200':
description: 'OK: Your request succeeded.'
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationsList'
'400':
$ref: '#/components/responses/400Response'
'500':
$ref: '#/components/responses/500Response'
security:
- bearerAuth:
- saas.consolidation.view.r
/api/saas/consolidated-view/v1/applications/lookup-values:
get:
summary: Get Applications Lookup Values
description: Returns the lookup values for applications.
operationId: getApplicationsLookupValues
tags:
- Applications
responses:
'200':
description: 'OK: Your request succeeded.'
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationsLookupValues'
'500':
$ref: '#/components/responses/500Response'
/api/saas/consolidated-view/v1/applications/{applicationId}:
get:
summary: Get Application
description: Returns the details of an application.
operationId: getApplication
tags:
- Applications
parameters:
- $ref: '#/components/parameters/ApplicationIdPath'
responses:
'200':
description: 'OK: Your request succeeded.'
content:
application/json:
schema:
$ref: '#/components/schemas/Application'
'400':
$ref: '#/components/responses/400Response'
'404':
$ref: '#/components/responses/404Response'
'500':
$ref: '#/components/responses/500Response'
security:
- bearerAuth:
- saas.consolidation.view.r
patch:
summary: Update Application
description: Modifies an application.
operationId: updateApplication
tags:
- Applications
parameters:
- $ref: '#/components/parameters/ApplicationIdPath'
requestBody:
required: true
description: An application to be updated.
content:
application/merge-patch+json:
schema:
$ref: '#/components/schemas/ApplicationPatch'
responses:
'200':
description: 'OK: Your request succeeded.'
content:
application/json:
schema:
$ref: '#/components/schemas/Application'
'400':
$ref: '#/components/responses/400Response'
'404':
$ref: '#/components/responses/404Response'
'500':
$ref: '#/components/responses/500Response'
security:
- bearerAuth:
- saas.consolidation.view.crud
/api/saas/consolidated-view/v1/applications/{applicationId}/kpi:
get:
summary: Get Application KPIs
description: Returns the details of an applications KPIs.
operationId: getSaasConsolidatedViewV1ApplicationsIdKpi
parameters:
- $ref: '#/components/parameters/ApplicationIdPath'
tags:
- Applications
responses:
'200':
description: 'OK: Your request succeeded.'
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationKPI'
'400':
$ref: '#/components/responses/400Response'
'404':
$ref: '#/components/responses/404Response'
'500':
$ref: '#/components/responses/500Response'
security:
- bearerAuth:
- saas.consolidation.view.r
/api/saas/consolidated-view/v1/overview/applications/kpi:
get:
summary: Get Applications Overview KPIs
description: Returns the details of the applications overview key performance indicators.
operationId: getApplicationOverview
tags:
- Applications
parameters:
- $ref: '#/components/parameters/FromDateQuery'
- $ref: '#/components/parameters/ToDateQuery'
responses:
'200':
description: 'OK: Your request succeeded.'
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationsOverviewKPI'
'400':
$ref: '#/components/responses/400Response'
'500':
$ref: '#/components/responses/500Response'
security:
- bearerAuth:
- saas.consolidation.view.r
/api/saas/consolidated-view/v1/applications/kpi:
get:
summary: Get Applications KPIs
description: Returns the details of the KPIs for all applications.
operationId: getApplicationsKpi
tags:
- Applications
parameters:
- $ref: '#/components/parameters/FromDateQuery'
- $ref: '#/components/parameters/ToDateQuery'
responses:
'200':
description: 'OK: Your request succeeded.'
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationsKPI'
'400':
$ref: '#/components/responses/400Response'
'500':
$ref: '#/components/responses/500Response'
security:
- bearerAuth:
- saas.consolidation.view.r
/api/saas/consolidated-view/v1/applications/{applicationId}/users:
get:
summary: Get Application Users
description: Returns a collection of users assigned to an application.
operationId: getapplicationusers
parameters:
- $ref: '#/components/parameters/ApplicationIdPath'
- $ref: '#/components/parameters/PageNumberQuery'
- $ref: '#/components/parameters/PageSizeQuery'
- $ref: '#/components/parameters/FilterQuery'
- $ref: '#/components/parameters/SortQuery'
responses:
'200':
description: 'OK: Your request succeeded.'
content:
application/json:
schema:
required:
- pagination
- items
properties:
pagination:
$ref: '#/components/schemas/PaginationResponse'
items:
description: A collection of users.
type: array
items:
$ref: '#/components/schemas/User'
'400':
$ref: '#/components/responses/400Response'
'404':
$ref: '#/components/responses/404Response'
'500':
$ref: '#/components/responses/500Response'
security:
- bearerAuth:
- saas.consolidation.view.r
tags:
- Applications
/api/saas/consolidated-view/v1/applications/{applicationId}/users/lookup-values:
get:
summary: Get Application Users Lookup Values
description: Returns a collection of distinct lookup values for application users.
operationId: getSaasConsolidatedViewV1UsersLookupValues
parameters:
- $ref: '#/components/parameters/ApplicationIdPath'
responses:
'200':
description: 'OK: Your request succeeded.'
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationLookUpResponse'
'404':
$ref: '#/components/responses/404Response'
'500':
$ref: '#/components/responses/500Response'
security:
- bearerAuth:
- saas.consolidation.view.r
tags:
- Applications
/api/saas/consolidated-view/v1/applications/bulk-update:
post:
summary: Bulk Update Applications
description: Modifies a collection of application properties the provided applications.
operationId: bulkUpdateApplications
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BulkUpdateApplicationsRequest'
responses:
'202':
description: 'Accepted: Your request requires more time for the service to process.'
content:
application/json:
schema:
$ref: '#/components/schemas/BulkUpdateApplicationsResponse'
'400':
$ref: '#/components/responses/400Response'
'500':
$ref: '#/components/responses/500Response'
security:
- bearerAuth:
- saas.consolidation.view.crud
tags:
- Applications
/api/saas/consolidated-view/v1/applications/{applicationId}/users/consumption:
get:
summary: Get Application Users Consumptions
description: Returns a collection of application users and their consumption details.
operationId: getSaasConsolidatedViewV1ApplicationUsersConsumption
parameters:
- $ref: '#/components/parameters/ApplicationIdPath'
- $ref: '#/components/parameters/PageNumberQuery'
- $ref: '#/components/parameters/PageSizeQuery'
- $ref: '#/components/parameters/FilterQuery'
- $ref: '#/components/parameters/SortQuery'
responses:
'200':
description: 'OK: Your request succeeded.'
content:
application/json:
schema:
required:
- pagination
- items
properties:
pagination:
$ref: '#/components/schemas/PaginationResponse'
items:
description: A collection of users.
type: array
items:
$ref: '#/components/schemas/ApplicationUserConsumption'
'400':
$ref: '#/components/responses/400Response'
'404':
$ref: '#/components/responses/404Response'
'500':
$ref: '#/components/responses/500Response'
security:
- bearerAuth:
- saas.consolidation.view.r
tags:
- Applications
components:
schemas:
ApplicationsList:
type: object
properties:
items:
description: A collection of applications.
type: array
items:
$ref: '#/components/schemas/Application'
pagination:
$ref: '#/components/schemas/PaginationResponse'
required:
- items
- pagination
Link:
type: object
required:
- href
- rel
- method
properties:
href:
type: string
description: The associated relative URL.
example: api/saas/consolidated-view/v1/...
rel:
type: string
description: Specifies the relationship between the current document and the linked document/resource.
example: self
method:
type: string
description: The method to access related resources.
example: GET
ApplicationPatch:
type: object
properties:
primaryOwnerId:
type: string
description: The unique ID of the primary owner.
example: 906b7a69-597e-4e13-bbda-5fb2dd903cc6
sanctioned:
type: boolean
description: '```true``` if application is sanctioned; otherwise, ```false```.'
example: true
singleSignOn:
type: boolean
description: '```true``` if application has single sign on supported; otherwise, ```false```.'
example: true
notes:
type: string
description: Notes about the application.
example: Notes about Illustrator.
description:
type: string
description: Description of the application.
example: Illustrator CC is a vector graphics editor and design program used by professionals to create digital graphics, illustrations, and typography. It is part of the Adobe Creative Cloud suite and is widely used for creating high-quality artwork for various me.
aiCategory:
type: string
description: AI category of the application.
example: Graphic Design
aiSubcategory:
type: string
description: AI sub-category of the application.
example: Vector Graphic Design
websiteDate:
$ref: '#/components/schemas/ApplicationPatchWebsite'
required:
- primaryOwnerId
- sanctioned
- singleSignOn
- notes
- description
- aiCategory
- aiSubcategory
- websiteDate
ErrorValidationResponse:
title: ErrorValidationResponse
description: Bad Request - Your request is invalid or improperly formed. Consequently, the API server could not understand your request.
type: object
properties:
error:
$ref: '#/components/schemas/ValidationError'
required:
- error
ApplicationLookUpResponse:
title: ApplicationLookUpResponse
type: object
properties:
roles:
description: A collection of roles assigned to users.
type: array
items:
type: string
example: Role1
required:
- roles
ValidationError:
type: object
description: Validation error.
properties:
code:
type: integer
description: The HTTP status code.
format: int32
example: 400
message:
type: string
description: The error message.
example: Filter field name needs to be formatted as a string.
required:
- code
- message
BulkUpdateApplicationsRequest:
type: object
required:
- scope
- body
properties:
filter:
description: For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).
type: string
example: name -eq Per
scope:
description: The scope of the update operation.
x-enumDescriptions:
Only: The operation is performed only on the applications whose IDs are specified.
All: The operation is performed on all applications.
AllExcept: The operation is performed on every application except those whose IDs are specified.
type: string
enum:
- Only
- All
- AllExcept
example: All
ids:
description: The IDs that the operation is performed on.
type: array
items:
type: string
example: 19bb4eb7-3012-435a-9845-55626ef40460
body:
$ref: '#/components/schemas/ApplicationMarkers'
ApplicationCertifications:
type: array
description: A collection of application certifications from MSDefender connector.
items:
type: string
example:
- SOC1
- ISO27001
ApplicationsOverviewKPI:
title: ApplicationsOverviewKPI
description: Overview of the application kpi.
type: object
properties:
applicationDiscoveryLastSevenDays:
description: The number of applications that are not approved but have user activity in them.
type: array
items:
$ref: '#/components/schemas/ApplicationDiscoveryLastSevenDays'
notApproved:
title: NotApproved
description: The number of applications that are not approved but have user activity in them.
type: object
total:
type: array
description: Total number of applications from all vendors compared to 30 days.
items:
$ref: '#/components/schemas/Total'
required:
- total
- notApproved
- applicationDiscoveryLastSevenDays
ApplicationPatchWebsite:
title: ApplicationPatchWebsite
type: object
properties:
website:
type: string
description: Website of application.
example: http://www.adobe.com/
privacyPolicy:
type: string
description: Location of the applications privacy policy.
example: https://www.adobe.com/privacy.html
categoryName:
type: string
description: Category of application.
example: Digital Content Editing Platform
required:
- website
- privacyPolicy
- categoryName
ApplicationUserConsumption:
title: ApplicationUserConsumption
type: object
properties:
id:
type: string
description: The unique ID of the application.
example: 19bb4eb7-3012-435a-9845-55626ef40460
createdDate:
type: string
format: date
description: Date of created Date.
example: '2024-10-01'
discoveryTypes:
type: array
description: A collection of discovery types.
items:
type: integer
format: int32
example: 1
isOnline:
type: boolean
description: '```true``` if user should be online; otherwise, ```false```.'
example: true
lastActiveValueType:
type: integer
description: User last active value type.
example: 5
userCostPerMonth:
description: The monthly cost of the user entitlements.
example: 1000
type: number
format: double
displayName:
type: string
description: Display name of the user.
example: John Doe.
isInReview:
type: boolean
description: '```true``` if user should be reviewed; otherwise, ```false```.'
example: true
lastActive:
type: string
format: date-time
description: Time of last user activity in relevant applications.
example: '2030-01-02T15:04:05'
lastActiveValueInInt:
type: integer
format: int32
example: 1
description: Last active value in int.
status:
type: string
description: Status of the user.
example: Active
roles:
type: array
items:
type: string
description: The list of roles user is assigned to.
example:
- GCS Support Engineer
isMonitored:
example: true
description: '```true``` if user should be Monitored; otherwise, ```false```.'
type: boolean
department:
type: string
description: Department of the user.
example: Sales
email:
description: The email address of the user.
example: john.doe@organization.com
type: string
isQualified:
description: '```true``` if has been marked to be included in Snow''s services which incur a cost; otherwise, ```false```.'
example: true
type: boolean
potentialSavings:
description: The monthly subscription costs for users who are inactive or have no activity.
example: 500
type: number
format: double
envelopeusage:
description: The usage of the subscription by the user.
type: integer
format: int32
example: 2
required:
- createdDate
- discoveryTypes
- isOnline
- lastActiveValueType
- userCostPerMonth
- displayName
- isInReview
- lastActive
- lastActiveValueInInt
- status
- role
- isMonitored
- department
- email
- id
- isQualified
- potentialSavings
- envelopeusage
Total:
title: Total
description: Total number of applications from all vendors compared to 30 days. ago.
type: object
properties:
trend:
description: The change in the number of applications from all vendors compared. to 30 days ago.
type: integer
format: int32
example: -1000
value:
description: The number of applications from all vendors.
type: integer
format: int32
example: 250
required:
- value
- trend
ErrorResponse:
description: Internal Server Error - Your request failed due to an internal error.
type: object
properties:
error:
$ref: '#/components/schemas/InternalError'
required:
- error
BulkUpdateApplicationsResponse:
type: object
required:
- id
- _links
properties:
id:
description: The unique ID of the bulk operation.
type: string
example: 483c67cf-e247-4a82-bef7-b86a29560788
_links:
type: array
description: A collection of links to related resources.
items:
$ref: '#/components/schemas/Link'
example:
- href: api/saas/consolidated-view/v1/tasks/483c67cf-e247-4a82-bef7-b86a29560788
rel: self
method: GET
ApplicationsCategory:
title: ApplicationsCategory
type: object
properties:
name:
type: string
description: Name of category.
example: Communication
total:
type: integer
format: int32
description: Total number of categories for stated application.
example: 10
required:
- name
- total
NotFoundResponse:
description: The requested resource could not be found.
type: object
properties:
error:
$ref: '#/components/schemas/NotFoundError'
required:
- error
ApplicationsUserCount:
title: ApplicationsCategory
type: object
properties:
name:
type: string
description: Name of application.
example: Communication
totalUsers:
type: integer
format: int32
description: Total number of users of stated application.
example: 10
required:
- name
- totalUsers
InternalError:
type: object
description: Internal error.
properties:
code:
type: integer
description: The HTTP status code.
format: int32
example: 500
message:
type: string
description: The error message.
example: The service encountered an unexpected condition that prevented it from fulfilling the request.
required:
- code
- message
ApplicationKPI:
title: ApplicationKPI
type: object
properties:
id:
type: string
description: The unique ID of the application.
example: e5ea6f20-47ad-41be-a3c5-839409d89791
monthlyCost:
$ref: '#/components/schemas/KpiPairFloat'
subscriptionTypes:
$ref: '#/components/schemas/KpiPairInt'
subscriptions:
$ref: '#/components/schemas/KpiPairInt'
totalUsers:
$ref: '#/components/schemas/KpiPairInt'
unassignedSubscriptions:
$ref: '#/components/schemas/KpiPairInt'
required:
- id
- monthlyCost
- subscriptions
- subscriptionTypes
- totalUsers
- unassignedSubscriptions
NotFoundError:
type: object
description: Not found error.
properties:
code:
type: integer
description: The HTTP status code.
format: int32
example: 404
message:
type: string
description: The error message.
example: Resource with ID '32aeda0a-80dc-475a-907f-2d250a3a8614' not found.
required:
- code
- message
License:
type: object
properties:
id:
type: string
description: The unique ID of the license.
example: e2e901ba-ad57-4433-a6ba-50178134852a
total:
type: integer
format: int32
description: Total assignable licenses.
example: 32
assigned:
type: integer
format: int32
description: Assigned licenses.
example: 27
productId:
type: string
description: The unique ID of the product.
example: 6a24e288-03f2-4237-8f1e-d6ed4e1ea0f4
collectionTargetId:
type: string
description: The unique ID of the collection.
example: 4770a19c-c789-4c10-82dd-062a4a23d6bb
required:
- id
Application:
type: object
properties:
id:
type: string
description: The unique ID of the application.
example: 19bb4eb7-3012-435a-9845-55626ef40460
name:
type: string
description: Name of the application.
example: Teams
vendor:
type: string
description: Name of the vendor of the application.
example: Microsoft Corp.
vendorId:
type: string
description: The unique ID of the vendor of the application.
example: 365540e0-3150-48b9-9841-dbff43925065
licenses:
type: array
description: Licenses under which application may be used.
items:
$ref: '#/components/schemas/License'
licenseCount:
type: integer
format: int32
description: Count of all licences.
example: 10
total:
type: integer
format: int32
description: Total amount.
example: 25
purchased:
type: integer
format: int32
description: How many are purchased.
example: 12
available:
type: integer
format: int32
description: How many are available.
example: 13
yearlyCost:
type: number
format: float32
description: Yearly cost of the usage.
example: 6.45
assigned:
type: integer
format: int32
description: How many are already assigned.
example: 5
active:
type: integer
format: int32
description: How many are actively being used.
example: 11
bundle:
type: boolean
description: '```true``` if application is part of the bundle; otherwise, ```false```.'
example: true
inactive:
type: integer
format: int32
description: How many are inactive.
example: 7
utilization:
type: number
description: Percentage being used.
example: 76.98
totalUniqueUsers:
type: integer
format: int32
description: Number of unique users.
example: 21
discoveryTypes:
type: array
description: A collection of discovery types.
items:
type: integer
format: int32
example: 1
discoveryDate:
type: string
format: date
description: Date of discovery.
example: '2024-10-01'
discoverySource:
type: string
description: Source of discovery.
example: Manual.
categoryName:
type: string
description: Category of application.
example: Digital Content Editing Platform
website:
type: string
description: Website of application.
example: http://www.adobe.com/
privacyPolicy:
type: string
description: Location of the applications privacy policy.
example: https://www.adobe.com/privacy.html
primaryOwnerId:
type: string
description: The unique ID of the primary owner.
example: 906b7a69-597e-4e13-bbda-5fb2dd903cc6
primaryOwnerName:
type: string
description: Name of primary owner.
example: Ryan Renolds
sanctioned:
type: boolean
description: '```true``` if application is sanctioned; otherwise, ```false```.'
example: true
singleSignOn:
type: boolean
description: '```true``` if application has single sign on supported; otherwise, ```false```.'
example: true
notes:
type: string
description: Notes about the application.
example: Notes about Illustrator.
disServiceId:
type: string
description: The unique ID of the DIS service.
example: a1a6f610-3a09-4ae4-87a0-7d4bf6218962
totalUniqueUsersFromActivities:
type: integer
format: int32
description: Total number of users based on the user activity.
example: 12
description:
type: string
description: Description of the application.
example: Illustrator CC is a vector graphics editor and design program used by professionals to create digital graphics, illustrations, and typography. It is part of the Adobe Creative Cloud suite and is widely used for creating high-quality artwork for various me.
aiCategory:
type: string
description: AI category of the application.
example: Graphic Design
aiSubcategory:
type: string
description: AI sub-category of the application.
example: Vector Graphic Design
riskScore:
type: integer
format: int32
description: Risk score of the application from MSDefender connector.
example: 5
certifications:
$ref: '#/components/schemas/ApplicationCertifications'
required:
- id
- name
- vendor
- vendorId
KpiPairInt:
title: KpiPairInt
description: KPI pair of values in integer format.
type: object
properties:
value30DaysAgo:
description: Value 30 days ago.
type: integer
format: int32
example: 20
valueCurrent:
description: Current value.
type: integer
format: int32
example: 10
required:
- valueCurrent
- value30DaysAgo
PaginationResponse:
description: The pagination details.
type: object
required:
- page_size
- page_number
properties:
page_size:
type: integer
description: The page size you requested.
example: 100
page_number:
type: integer
format: int64
description: The page number you requested.
example: 1
total_pages:
type: integer
format: int64
description: The total number of pages.
example: 1
total_items:
type: integer
format: int64
description: The total number of items.
example: 1
User:
title: User
description: A discovered user in your SaaS estate.
type: object
properties:
country:
description: The country of the user.
example: Japan
type: string
createdDate:
description: The date the user was created.
example: '2024-05-25T00:00:00Z'
type: string
format: date-time
department:
description: The department of the user.
example: Engineering
type: string
discoveryTypes:
description: The unique IDs of the discovery source types where the user was detected. For information on discovery source types, see https://docs.snowsoftware.io/snow-atlas/user-documentation/saas/saas-discovery#discovery-sources.
example:
- 1
- 2
x-enumDescriptions:
'0': SaaS connector - Represents integration with SaaS app
# --- truncated at 32 KB (43 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/snow-software/refs/heads/main/openapi/snow-software-applications-api-openapi.yml