List apps
Returns a list of apps used in the organization.<br/><br/><hr /><br/><br/>Filtering is available via the documented query parameters below and by custom application fields.<br/><br/>Example:<br/><br/>GET /apps?fields=id,name,myCustomField&state=discovered&myCustomField=true<br/><br/>The above example returns a list of applications that are in discovered state and myCustomField is true. Each application object will contain the id, name and myCustomField fields.<br/><br/>Use includeLicenses=true to include aggregated license summary for each app.<br/><br/>
<p><ul><li>Rate limit: 200 requests per minute</li></ul></p>Request
- Base URLhttps://api.toriihq.com/v1.0
- AuthAPI key in header Authorization
Query parameters
List of fields to return for each application.<br>Allowed fields: id, name, primaryOwner, appOwners, state, category, url, imageUrl, description, tags, score, score60, score90, isCustom, addedBy, creationTime, isHidden, sources, vendor, activeUsersCount, displayActiveUsersCount, lastVisitTime and all fields from /apps/fields
JSON string representing aggregation configuration. Structure: '{"field":"string","aggregationType":"metric|groupBy|date_range|date_histogram","options":{"size":"integer","sort":{"field":"string","order":"desc|asc","aggFunc":"total|sum|avg|max|min"},"metricFunction":"total|sum|avg|max|min","dateHistogramOptions":{"datePeriod":"hourly|daily|weekly|monthly|quarterly|yearly","hardBounds":{"min":"string","max":"string"},"extendedBounds":{"min":"string","max":"string"},"filterEmptyBuckets":"boolean"}},"aggs":{"field":"string","aggregationType":"metric|groupBy|date_range|date_histogram","options":{"metricFunction":"total|sum|avg|max|min"}}}'. metricFunction is REQUIRED when aggregationType is "metric". For aggregationType "date_histogram", options.dateHistogramOptions is REQUIRED and datePeriod, hardBounds, extendedBounds and filterEmptyBuckets all live INSIDE it — putting them directly on options is rejected with 400 "options.dateHistogramOptions" is required. The nested "aggs" is OPTIONAL and, when present, must be a JSON OBJECT with this same structure — never a JSON-encoded string.
The query to search
A comma-seperated list of fields to sort by, with a postfix with either ':asc' or ':desc'. Fields can either be general, or custom to your organization
Filters expression — accepts either shape: (1) Flat array of filter objects, AND-combined. Each item is {key, op, value}. (2) Array of filter groups, OR-combined. Each item is {id, filters} where filters is a flat array. See *_fields_metadata for valid keys and per-filterType operators. Omit value for isSet/isNotSet/relativeDateToday/exists/notExists. Use an array value for anyOf/allOf/noneOf/isExactly. Sent on the wire as a JSON-encoded string.
The max amount of results to return
A base64 string indicating the offset from which to start. <br>Pass the value of nextCursor returned from the previous call to get the next set of results
Include aggregated license summary for each app
Response
Apps
Example response
{
"apps": [
{
"id": 1000,
"primaryOwner": {
"firstName": "Tony",
"lastName": "Tony",
"photoUrl": "www.photo.com",
"lifecycleStatus": "active",
"fullName": "Tony",
"isDeletedInIdentitySources": true,
"id": 1000,
"email": "tony@stark.com",
"status": "active"
},
"name": "Salesforce",
"state": "discovered",
"url": "https://example.com",
"category": "Developer Tools",
"description": "Awesome application",
"tags": "DevOps,Human Resource"
}
],
"count": 100,
"total": 1000,
"nextCursor": "WzE0NjM1Mzg4NTcsIjY1NDMyMyJd"
}Changes
No recorded changes to this operation across all 1 revision of this API.