Subscriptions

• Subscriptions
  • getGet subscription insight users
  • delDelete subscription users
  • getGet subscription users
  • getGet subscription user consumptions

API docs by Redocly

SaaS: Subscriptions (1.1.1)

Download OpenAPI specification:Download

URL: https://www.flexera.com

API for interacting with SaaS Subscriptions.

Subscriptions

Get subscription insight users

Returns a collection of users for a subscription insight.

Authorizations:

bearerAuth

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_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

https://{region}.snowsoftware.io/api/saas/consolidated-view/v1/subscriptions/{subscriptionId}/insights/{insightRuleId}/users

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "country": "Japan",
    • "createdDate": "2024-05-25T00:00:00Z",
    • "department": "Engineering",
    • "discoveryTypes": {

      • "0": 1,
      • "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",
    • "employmentStatus": "Employed",
    • "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:

bearerAuth

path Parameters

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

Responses

https://{region}.snowsoftware.io/api/saas/consolidated-view/v1/subscriptions/{subscriptionId}/users/{userIds}

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:

bearerAuth

path Parameters

subscriptionId required

string Example: a7a75b83-2690-4cc9-b652-a0fbe93dba4a The unique ID of the subscription.

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.

Responses

https://{region}.snowsoftware.io/api/saas/consolidated-view/v1/subscriptions/{subscriptionId}/users

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": {

      • "0": 1,
      • "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",
    • "employmentStatus": "Employed"

    }

  ]

}

Get subscription user consumptions

Returns a collection of subscription users and their consumption details.

Authorizations:

bearerAuth

path Parameters

subscriptionId required

string Example: a7a75b83-2690-4cc9-b652-a0fbe93dba4a The unique ID of the subscription.

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

https://{region}.snowsoftware.io/api/saas/consolidated-view/v1/subscriptions/{subscriptionId}/users/consumption

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 1,
  • "total_items": 1

  },
• "items": [

  • {

    • "activityThreshold": 10,
    • "country": "India",
    • "createdDate": "2024-10-01",
    • "department": "Sales",
    • "id": "ac2c7870-6457-4a99-bafb-467eaf5de8e4",
    • "discoveryTypes": [

      • 1

      ],
    • "displayName": "John Doe.",
    • "email": "john.doe@organization.com",
    • "isEnabled": true,
    • "isInReview": true,
    • "isMonitored": true,
    • "isOnline": true,
    • "isQualified": true,
    • "lastActive": "2030-01-02T15:04:05",
    • "lastActiveValueInInt": 1,
    • "lastActiveValueType": 5,
    • "licenseCount": 10,
    • "manuallyAssigned": true,
    • "potentialSavings": 500,
    • "roles": {

      • "0": "GCS Support Engineer"

      },
    • "status": "Active",
    • "userCostPerMonth": 1000,
    • "username": "john.doe@organization.com",
    • "envelopeusage": 2

    }

  ]

}