Skip to main content

Applications

API docs by Redocly

SaaS: Applications (1.4.1)

Download OpenAPI specification:Download

URL: https://www.flexera.com

API for interacting with SaaS applications.

Applications

Get applications

Returns the details of a list of applications.

Authorizations:
bearerAuth
query Parameters
page_number
integer <int32>
Default: 1

The page number.

page_size
integer <int32>
Default: 100

The maximum number of items in the response.

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

Content type
application/json
{
  • "items": [
    ],
  • "pagination": {
    }
}

Get applications lookup values

Returns the lookup values for applications.

Responses

Response samples

Content type
application/json
{
  • "certifications": {
    }
}

Get application

Returns the details of an application.

Authorizations:
bearerAuth
path Parameters
applicationId
required
string

The unique ID of the application.

Responses

Response samples

Content type
application/json
{
  • "id": "19bb4eb7-3012-435a-9845-55626ef40460",
  • "name": "Teams",
  • "vendor": "Microsoft Corp.",
  • "vendorId": "365540e0-3150-48b9-9841-dbff43925065",
  • "licenses": [
    ],
  • "licenseCount": 10,
  • "total": 25,
  • "purchased": 12,
  • "available": 13,
  • "yearlyCost": 6.45,
  • "assigned": 5,
  • "active": 11,
  • "bundle": true,
  • "inactive": 7,
  • "utilization": 76.98,
  • "totalUniqueUsers": 21,
  • "discoveryTypes": [
    ],
  • "discoveryDate": "2024-10-01",
  • "discoverySource": "Manual.",
  • "categoryName": "Digital Content Editing Platform",
  • "website": "http://www.adobe.com/",
  • "privacyPolicy": "https://www.adobe.com/privacy.html",
  • "primaryOwnerId": "906b7a69-597e-4e13-bbda-5fb2dd903cc6",
  • "primaryOwnerName": "Ryan Renolds",
  • "sanctioned": true,
  • "singleSignOn": true,
  • "notes": "Notes about Illustrator.",
  • "disServiceId": "a1a6f610-3a09-4ae4-87a0-7d4bf6218962",
  • "totalUniqueUsersFromActivities": 12,
  • "description": "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": "Graphic Design",
  • "aiSubcategory": "Vector Graphic Design",
  • "riskScore": 5,
  • "certifications": {
    }
}

Update application

Modifies an application.

Authorizations:
bearerAuth
path Parameters
applicationId
required
string

The unique ID of the application.

Request Body schema: application/merge-patch+json
required

An application to be updated.

primaryOwnerId
required
string

The unique ID of the primary owner.

sanctioned
required
boolean

true if application is sanctioned; otherwise, false.

singleSignOn
required
boolean

true if application has single sign on supported; otherwise, false.

notes
required
string

Notes about the application.

description
required
string

Description of the application.

aiCategory
required
string

AI category of the application.

aiSubcategory
required
string

AI sub-category of the application.

required
object (ApplicationPatchWebsite)
website
required
string

Website of application.

privacyPolicy
required
string

Location of the applications privacy policy.

categoryName
required
string

Category of application.

Responses

Request samples

Content type
application/merge-patch+json
{
  • "primaryOwnerId": "906b7a69-597e-4e13-bbda-5fb2dd903cc6",
  • "sanctioned": true,
  • "singleSignOn": true,
  • "notes": "Notes about Illustrator.",
  • "description": "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": "Graphic Design",
  • "aiSubcategory": "Vector Graphic Design",
  • "websiteDate": {}
}

Response samples

Content type
application/json
{
  • "id": "19bb4eb7-3012-435a-9845-55626ef40460",
  • "name": "Teams",
  • "vendor": "Microsoft Corp.",
  • "vendorId": "365540e0-3150-48b9-9841-dbff43925065",
  • "licenses": [
    ],
  • "licenseCount": 10,
  • "total": 25,
  • "purchased": 12,
  • "available": 13,
  • "yearlyCost": 6.45,
  • "assigned": 5,
  • "active": 11,
  • "bundle": true,
  • "inactive": 7,
  • "utilization": 76.98,
  • "totalUniqueUsers": 21,
  • "discoveryTypes": [
    ],
  • "discoveryDate": "2024-10-01",
  • "discoverySource": "Manual.",
  • "categoryName": "Digital Content Editing Platform",
  • "website": "http://www.adobe.com/",
  • "privacyPolicy": "https://www.adobe.com/privacy.html",
  • "primaryOwnerId": "906b7a69-597e-4e13-bbda-5fb2dd903cc6",
  • "primaryOwnerName": "Ryan Renolds",
  • "sanctioned": true,
  • "singleSignOn": true,
  • "notes": "Notes about Illustrator.",
  • "disServiceId": "a1a6f610-3a09-4ae4-87a0-7d4bf6218962",
  • "totalUniqueUsersFromActivities": 12,
  • "description": "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": "Graphic Design",
  • "aiSubcategory": "Vector Graphic Design",
  • "riskScore": 5,
  • "certifications": {
    }
}

Get application KPIs

Returns the details of an applications KPIs.

Authorizations:
bearerAuth
path Parameters
applicationId
required
string

The unique ID of the application.

Responses

Response samples

Content type
application/json
{
  • "id": "e5ea6f20-47ad-41be-a3c5-839409d89791",
  • "monthlyCost": {
    },
  • "subscriptionTypes": {
    },
  • "subscriptions": {
    },
  • "totalUsers": {
    },
  • "unassignedSubscriptions": {
    }
}

Get applications overview KPIs

Returns the details of the applications overview key performance indicators.

Authorizations:
bearerAuth
query Parameters
fromDate
required
string <date>
Example: fromDate=2024-11-26

Starting date from which to calculate KPI.

toDate
required
string <date>
Example: toDate=2024-11-26

Starting date until which to calculate KPI.

Responses

Response samples

Content type
application/json
{
  • "applicationDiscoveryLastSevenDays": [
    ],
  • "notApproved": { },
  • "total": [
    ]
}

Get applications KPIs

Returns the details of the KPIs for all applications.

Authorizations:
bearerAuth
query Parameters
fromDate
required
string <date>
Example: fromDate=2024-11-26

Starting date from which to calculate KPI.

toDate
required
string <date>
Example: toDate=2024-11-26

Starting date until which to calculate KPI.

Responses

Response samples

Content type
application/json
{
  • "totalApplications": 15,
  • "totalApplicationsTrend": 7,
  • "unsanctioned": 2,
  • "appCategories": [
    ],
  • "aiAppCategories": [
    ],
  • "appCategoriesUnsanctioned": [
    ],
  • "aiAppCategoriesUnsanctioned": [
    ],
  • "activeUserApplications": [
    ],
  • "activeUserApplicationsUnsanctioned": [
    ]
}

Get application users

Returns a collection of users assigned to an application.

Authorizations:
bearerAuth
path Parameters
applicationId
required
string

The unique ID of the application.

query Parameters
page_number
integer <int32>
Default: 1

The page number.

page_size
integer <int32>
Default: 100

The maximum number of items in the response.

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

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Get application users lookup values

Returns a collection of distinct lookup values for application users.

Authorizations:
bearerAuth
path Parameters
applicationId
required
string

The unique ID of the application.

Responses

Response samples

Content type
application/json
{
  • "roles": [
    ]
}

Bulk update applications

Modifies a collection of application properties the provided applications.

Authorizations:
bearerAuth
Request Body schema: application/json
filter
string

For more information on the available operators and which data types those operators work on, see Filter API call results.

scope
required
string
Enum Description
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.

The scope of the update operation.

ids
Array of strings

The IDs that the operation is performed on.

required
object (ApplicationMarkers)

The update to be applied to all IDs.

singleSignOn
required
boolean

true if the application is marked as single sign-on only; otherwise, false.

approved
required
boolean

true if the application is marked as for approved; otherwise, false.

Responses

Request samples

Content type
application/json
{
  • "filter": "name -eq Per",
  • "scope": "All",
  • "ids": [
    ],
  • "body": {
    }
}

Response samples

Content type
application/json
{
  • "id": "483c67cf-e247-4a82-bef7-b86a29560788",
  • "_links": {
    }
}

Get application users consumptions

Returns a collection of application users and their consumption details.

Authorizations:
bearerAuth
path Parameters
applicationId
required
string

The unique ID of the application.

query Parameters
page_number
integer <int32>
Default: 1

The page number.

page_size
integer <int32>
Default: 100

The maximum number of items in the response.

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

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ]
}

Tasks

Get task

Returns the details of the given task.

Authorizations:
bearerAuth
path Parameters
id
required
string
Example: 5b35aa33-e7a8-47a3-b1b6-19099ebb6bfd

The unique ID of the task.

Responses

Response samples

Content type
application/json
{
  • "id": "483c67cf-e247-4a82-bef7-b86a29560788",
  • "name": "Bulk update applications",
  • "status": "Complete",
  • "description": "The export completed successfully.",
  • "_links": {
    }
}