{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"6cf66efb-8b9f-4084-bd50-c47ad4c4ff41","name":"SecureONE API","description":"The SecureONE API allows programmatic access to SecureONE.\n\n# Suggested Postman setup\n\nTo set up Postman for application development/API testing, create a new Environment with the following variable names:\n\n| Name | Description |\n| --- | --- |\n| baseUrl | This will be the URL for your SecureONE instance, including https://, the IP address or hostname, used for API calls |\n| username | The AD username for the user logging in to the API. Note that system access requests, system access expiration and other calls will be performed on, and logged as, this user. |\n| domain | AD domain NetBIOS name for the username |\n| password | AD user account password for the username |\n| accessToken | This variable will automatically be populated after successful authentication. The `accessToken` is used within the `Authorization Bearer` header for authentication API calls |\n\n### Example:\n\n| Name | Value |\n| --- | --- |\n| baseUrl | {{baseUrl}} |\n| username | {{username}} |\n| domain | {{domain}} |\n| password | {{password}} |\n| accessToken | {{accessToken}} |\n\n# Results Pagination\n\nIn order to support a larger maximum number of objects and efficient retrieval of all entities, SecureONE supports pagination on many `GET` endpoints.\n\n*   By default, 100 records are returned at a time. If there are less than 100 total records, then all records are returned upon the first API call, and no pagination is required.\n*   If there are more than 100 total records, the requester must make subsequent calls to retrieve additional records.\n    \n\n# Pagination URL (request)\n\nThe following URL parameters may be used to control the pagination of results:\n\n| Param | Description |\n| --- | --- |\n| page | Add `?page=x` to the URL on the `GET` request, where `x` is the integer number of the page (page number) you wish to request |\n| limit | Add `&limit=y` to the URL on the `GET` request, where `y` limits the number of records returned. (*Default: 100, Max: 1000*) |\n\n# Pagination Headers (response)\n\n| Header | Description |\n| --- | --- |\n| X-Pagination-Count | Total number of records being returned in the current response/page |\n| X-Pagination-Max-Count | Max number of records returned in a response/page |\n| X-Pagination-Page | Current page number |\n| X-Pagination-Pages | Total number of pages available |\n| X-Pagination-Total | Total number of records available |\n| Link | Generated pagination links containing `last`, `first` and `next` URLs |\n\n# Advanced Query API\n\nAdvanced Query API was developed to allow for querying of objects using the API. It can be used for querying the API for computers, groups, and users. See below for more detail on how to enable and use the AQ API.\n\n**FIELD SELECTION**\n\nYou can include the `select` query parameter to specify specific fields to return in the results. For example, `&select=cn,policy.scan,` returns only fields `cn` and `policy.scan` in the results. Without a `select` parameter included all available fields are returned in the results. Additionally, fields specified in the `select` parameter that are not shown by default will be ignored in the query. This may cause an error if there are no valid fields in the selection.\n\n*   use `?advanced=true` to enable AQ behavior\n*   results are paginated by default\n    *   max results per page is 1,000\n*   Current Supported Endpoints:\n    *   `/api/v1/computers?advanced=true`\n    *   `/api/v1/groups?advanced=true`\n    *   `/api/v1/users?advanced=true`\n\n| Operation | Query String |\n| --- | --- |\n| equal (case-sensitive) | `?foo=bar` |\n| unequal (case-sensitive) | `?foo=!bar` |\n| exists | `?foo=` |\n| not exists | `?foo=!` |\n| greater than | `?foo=>10` |\n| greater than equal to | `?foo=>=10` |\n| less than | `?foo=<10` |\n| less than equal to | `?foo=<=10` |\n| starts with | `?foo=^bar` |\n| ends with | `?foo=$bar` |\n| contains | `?foo=~bar` |\n| in array | `?foo[]=bar&foo[]=baz` |\n| not in array | `?foo[]=!bar&foo[]=!baz` |\n\n**EXAMPLE:**\n\n`GET /api/v1/computers?advanced=true&cn=accounting01&select=cn,policy.scan`","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"2212158","team":117409,"collectionId":"6cf66efb-8b9f-4084-bd50-c47ad4c4ff41","publishedId":"S1ZufXUo","public":true,"publicUrl":"https://api-docs.remediant.com","privateUrl":"https://go.postman.co/documentation/2212158-6cf66efb-8b9f-4084-bd50-c47ad4c4ff41","customColor":{"top-bar":"303030","right-sidebar":"303030","highlight":"7B1A1F"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2019-06-20T16:25:29.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"SecureONE Mock Server","id":"c113dadb-9957-4a83-83be-74749c8f330f","owner":"2212158","values":[{"key":"baseUrl","value":"https://83f0bcdb-9fe9-48f4-a5a5-1e1cdae48573.mock.pstmn.io","enabled":true},{"key":"username","value":"bishop","enabled":true},{"key":"domain","value":"RTEST","enabled":true},{"key":"password","value":"MySecurePassword123$","enabled":true},{"key":"accessToken","value":"","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/83515207c89e08cb14ebacc2355ded828546b58c6c90043bc20a07578c054698","favicon":"https://res.cloudinary.com/postman/image/upload/v1545259448/team/ccesq3tbyt3dy884ow1m.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"SecureONE Mock Server","value":"2212158-c113dadb-9957-4a83-83be-74749c8f330f"}],"canonicalUrl":"https://api-docs.remediant.com/view/metadata/S1ZufXUo"}