openapi-directory/api/intellifi.nl.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.1","servers":[{"description":"Cloud hosted Brain API endpoint.","url":"{protocol}://{customer}.intellifi.{tld}/api","variables":{"customer":{"default":"brain","description":"Customer sub-domain assigned by Intellifi"},"protocol":{"default":"https","enum":["https","http"]},"tld":{"default":"cloud","enum":["nl","cloud"]}}}],"info":{"contact":{"email":"support@intellifi.nl","name":"Support","url":"https://intellifi.zendesk.com"},"description":"This document describes the [Intellifi Brain](https://intellifi.zendesk.com/hc/en-us/categories/360000685454)\nWeb API specification using the [OpenAPI specification](https://github.com/OAI/OpenAPI-Specification).\n\nThe Brain Web API is a RESTful API that allows you to interact with the\n[Intellifi devices](https://intellifi.zendesk.com/hc/en-us/categories/360000685434) and\nservices in a powerful and simple way. Our end-to-end solution allows you to\nlocalize your items/assets based on technologies such as RFID and Bluetooth.\n\n# Try it out!\n\nThe API can be tried out and tested using the ['api-doc/tryitout' endpoint on this site](./tryitout/).\nThis UI allows anyone to visualize and interact with the API’s resources without having any of the implementation logic in place.\nIt’s automatically generated from this Specification, with the visual documentation making it easy for back end implementation and client side consumption.\n\n# Authentication\n\nApplications are required to provide some form of authentication to the API\nfor every secured endpoint. The Brain offers two forms of authentication.\n\n- API key (Via an HTTP request header or URL parameter)\n- Session cookie\n\n<!-- ReDoc-Inject: <security-definitions> -->\n\n# See also\n\n- About Intellifi and what we do: [intellifi.nl](https://intellifi.nl)\n- Technical and background information: [intellifi.zendesk.com](https://intellifi.zendesk.com)\n","license":{"name":"MIT","url":"./LICENSE"},"title":"Brain Web API","version":"2.23.4+0.gb463b49.dirty","x-apisguru-categories":["iot"],"x-logo":{"altText":"Intellifi logo","backgroundColor":"#FFFFFF","url":"https://avatars1.githubusercontent.com/u/9928538?s=200&v=4"},"x-origin":[{"format":"openapi","url":"https://intellifi-nl.github.io/brain-rest-api-spec/openapi.yml","version":"3.0"}],"x-providerName":"intellifi.nl"},"externalDocs":{"description":"Find out more","url":"https://intellifi.zendesk.com"},"security":[{"CookieSid":[]},{"HeaderApiKey":[]},{"QueryApiKey":[]}],"tags":[{"description":"Read-only route providing information about how the requesting client is authenticated on the API, as well as corresponding permissions.\n","name":"authinfo"},{"description":"The `blobs` resource provides a service for storing binary objects on the Brain, e.g. images.\nIntended for applications that interact with the Brain but do not or cannot have their own (centralized) persistent storage.\n\nSee also the `kvpairs` resource.\n","name":"blobs"},{"description":"The `events` resource temporarily holds Brain events that match an event subscription in the `subscriptions` resource.\nThe subscription determines how long the events are held.\n\nSee also the `subscriptions` resource.\n","externalDocs":{"url":"https://intellifi.zendesk.com/hc/en-us/sections/360001588534"},"name":"events"},{"description":"The `items` resource contains data about things that can be tracked using the Brain.\nWhen an item is detected for the first time by a device connected to the Brain, it will be added to this resource.\nIt will then be updated with information about where the item currently is, or where it has been seen for the last time.\n","externalDocs":{"url":"https://intellifi.zendesk.com/hc/en-us/articles/360007502554"},"name":"items"},{"description":"The `keys` resource contains the access keys used to authenticate requests to this API.\n\nNote that this resource is only accessible for administrator users logged into the Brain Management Console.\nIt is not possible to access this resource using API key authentication.\nThis resource is therefore irrelevant to most applications.\n","name":"keys"},{"description":"The `kvpairs` resource provides a service for storing generic JSON key/value pairs on the Brain.\nIntended for applications that interact with the Brain but do not or cannot have their own (centralized) persistent storage.\n\nSee also the `blobs` resource.\n","name":"kvpairs"},{"description":"The `locations` resource is an abstraction for the area around a physical location that items can be localized at.\n","externalDocs":{"url":"https://intellifi.zendesk.com/hc/en-us/articles/360007502554"},"name":"locations"},{"description":"Location rules are directives for the localization engine that may be useful for certain solutions.\n","name":"locationrules"},{"description":"The `presences` resource is an abstraction for the detection of an item (from the `items` resource) at a location (from the `locations` resource).\nPresences are always kept current by the Brain, i.e. if the hold time of a presence expires it is simply removed from the resource.\n","externalDocs":{"url":"https://intellifi.zendesk.com/hc/en-us/articles/360008309313"},"name":"presences"},{"description":"The Brain consists of several software components with their own responsibilities, referred to as \"services\".\nSome of these services have status information and/or configuration that can be managed using the `services` resource.\n","name":"services"},{"description":"It can be useful to group items or Smartspots in a list. The `sets` resource can be used to create and manage such list sets.\nSets can be utilized in various Brain Management Console utilities and can also be useful in custom Brain applications.\n","externalDocs":{"url":"https://intellifi.zendesk.com/hc/en-us/articles/360007824993"},"name":"sets"},{"description":"The `spots` resource contains representations of Smartspot devices that have connected to this Brain at least once.\nIt is possible to configure Smartspots through this resource.\n\nSmartspots also have their own locally stored sets, referred to as \"spotsets\".\nSpotsets can be created and managed within a single spot instance or by using `spotsets` resource.\nCreated or updated spotsets are automatically synced between Smartspot and server.\n","externalDocs":{"url":"https://intellifi.zendesk.com/hc/en-us/categories/360000685434"},"name":"spots"},{"description":"The `spotsets` resource contains a collection of set definitons for each Smartspot and allows for remote mananagement.\nSpotsets are stored and used on the Smartspot locally and synced between Smartspot and server.\nSpotsets primarly are used as an input for Sense&Control.\n","externalDocs":{"url":"https://intellifi.zendesk.com/hc/en-us/articles/360009282834"},"name":"spotsets"},{"description":"The `subscriptions` resource contains rules to store and/or deliver events from the Brain event system.\n\nSee also the `events` resource.\n","externalDocs":{"url":"https://intellifi.zendesk.com/hc/en-us/sections/360001588534"},"name":"subscriptions"},{"description":"The `users` resource contains the user accounts that can log into the Brain Management Console.\n\nNote that this resource is only accessible for administrator users logged into the Brain Management Console.\nIt is not possible to access this resource using API key authentication.\nThis resource is therefore irrelevant to most applications.\n","name":"users"}],"paths":{"/authinfo":{"get":{"operationId":"getAuthinfo","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"api_key_id":{"description":"Reference to the static API key (/api/keys) used to authenticate this request (when auth_method=static_api_key)","example":"5b7d6cbd7503c445552a1664","type":"string"},"auth_method":{"description":"What kind of authentication was used","enum":["user_session","internal","static_api_key"],"type":"string"},"authenticated":{"description":"Whether or not you are authenticated","type":"boolean"},"permissions":{"properties":{"mutate":{"description":"Whether or not this session can mutate resources","type":"boolean"}},"type":"object"},"url":{"$ref":"#/components/schemas/Url"},"user_id":{"description":"Reference to the user account (/api/users) used to authenticate this request (when auth_method=user_session)","example":"5b7d6cbd7503c445552a1664","type":"string"}},"type":"object"}}},"description":"A JSON object containing the authentication information"}},"summary":"Authentication information","tags":["authinfo"]}},"/blobs":{"get":{"operationId":"getBlobs","parameters":[{"$ref":"#/components/parameters/After"},{"$ref":"#/components/parameters/AfterId"},{"$ref":"#/components/parameters/Before"},{"$ref":"#/components/parameters/BeforeId"},{"$ref":"#/components/parameters/From"},{"$ref":"#/components/parameters/FromId"},{"$ref":"#/components/parameters/IdOnly"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Populate"},{"$ref":"#/components/parameters/ResultsOnly"},{"$ref":"#/components/parameters/Select"},{"$ref":"#/components/parameters/Sort"},{"$ref":"#/components/parameters/Until"},{"$ref":"#/components/parameters/UntilId"},{"$ref":"#/components/parameters/TimeoutS"},{"$ref":"#/components/parameters/Id"},{"$ref":"#/components/parameters/TimeCreated"},{"$ref":"#/components/parameters/TimeUpdated"},{"description":"Filter based on the hash of the blob.","in":"query","name":"hash","schema":{"type":"string"}},{"description":"Filter based on the unique blob_key","in":"query","name":"blob_key","schema":{"type":"string"}},{"description":"Filter based on the content type of the blob.","in":"query","name":"content_type","schema":{"type":"string"}},{"description":"Filter based on the filename of the blob.","in":"query","name":"filename","schema":{"type":"string"}},{"description":"Filter based on the last time the blob was accessed","in":"query","name":"time_last_accessed","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ResponseEnvelope"},{"properties":{"results":{"items":{"$ref":"#/components/schemas/Blob"},"type":"array"}},"type":"object"}]}}},"description":"A JSON object containing a list of blobs"}},"summary":"Get all binary large objects (blob)","tags":["blobs"]},"post":{"operationId":"addBlob","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Blob"}}},"description":"A JSON object containing blob information","required":true},"responses":{"201":{"$ref":"#/components/responses/OkPost"}},"summary":"Create binary large object (blob) metadata","tags":["blobs"]}},"/blobs/{id}":{"delete":{"operationId":"deleteBlob","parameters":[{"$ref":"#/components/parameters/PathId"}],"responses":{"200":{"$ref":"#/components/responses/200OkDelete"}},"summary":"Delete binary large object (blob)","tags":["blobs"]},"get":{"operationId":"getBlobMetadataById","parameters":[{"$ref":"#/components/parameters/PathId"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Blob"}}},"description":"A JSON object containing the blob"}},"summary":"Get binary large object (blob)","tags":["blobs"]}},"/blobs/{id}/download/{filename}":{"get":{"operationId":"getBlobById","parameters":[{"$ref":"#/components/parameters/PathId"},{"description":"Filename of the blob.","in":"path","name":"filename","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"image/*":{"schema":{"format":"binary","type":"string"}}},"description":"The stored binary blob"}},"summary":"Download a binary large object (blob)","tags":["blobs"]}},"/blobs/{id}/upload":{"post":{"operationId":"uploadBlobById","parameters":[{"$ref":"#/components/parameters/PathId"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file":{"format":"binary","type":"string"}}}}}},"responses":{"200":{"description":"Upload was successful"}},"summary":"Create binary large object (blob)","tags":["blobs"]}},"/events":{"get":{"operationId":"getEvents","parameters":[{"$ref":"#/components/parameters/After"},{"$ref":"#/components/parameters/AfterId"},{"$ref":"#/components/parameters/Before"},{"$ref":"#/components/parameters/BeforeId"},{"$ref":"#/components/parameters/From"},{"$ref":"#/components/parameters/FromId"},{"$ref":"#/components/parameters/IdOnly"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Populate"},{"$ref":"#/components/parameters/ResultsOnly"},{"$ref":"#/components/parameters/Sort"},{"$ref":"#/components/parameters/Until"},{"$ref":"#/components/parameters/UntilId"},{"$ref":"#/components/parameters/TimeoutS"},{"$ref":"#/components/parameters/Id"},{"$ref":"#/components/parameters/TimeCreated"},{"$ref":"#/components/parameters/TopicResourceType"},{"$ref":"#/components/parameters/TopicAction"},{"$ref":"#/components/parameters/TopicResource"},{"$ref":"#/components/parameters/TimeEvent"},{"$ref":"#/components/parameters/TimeExpire"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ResponseEnvelope"},{"properties":{"results":{"items":{"$ref":"#/components/schemas/Event"},"type":"array"}},"type":"object"}]}}},"description":"A JSON object containing a list of events"}},"summary":"Get all events","tags":["events"]}},"/events/{id}":{"get":{"operationId":"getEventById","parameters":[{"$ref":"#/components/parameters/PathId"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}},"description":"A JSON object containing the event"}},"summary":"Get event","tags":["events"]}},"/items":{"get":{"operationId":"getItems","parameters":[{"$ref":"#/components/parameters/After"},{"$ref":"#/components/parameters/AfterId"},{"$ref":"#/components/parameters/AfterCode"},{"$ref":"#/components/parameters/Before"},{"$ref":"#/components/parameters/BeforeId"},{"$ref":"#/components/parameters/BeforeCode"},{"$ref":"#/components/parameters/From"},{"$ref":"#/components/parameters/FromId"},{"$ref":"#/components/parameters/FromCode"},{"$ref":"#/components/parameters/IdOnly"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Populate"},{"$ref":"#/components/parameters/ResultsOnly"},{"$ref":"#/components/parameters/Select"},{"$ref":"#/components/parameters/Sort"},{"$ref":"#/components/parameters/Until"},{"$ref":"#/components/parameters/UntilId"},{"$ref":"#/components/parameters/TimeoutS"},{"$ref":"#/components/parameters/UntilCode"},{"$ref":"#/components/parameters/Id"},{"$ref":"#/components/parameters/TimeCreated"},{"$ref":"#/components/parameters/TimeUpdated"},{"$ref":"#/components/parameters/CodeHex"},{"$ref":"#/components/parameters/IsPresent"},{"$ref":"#/components/parameters/Label"},{"$ref":"#/components/parameters/Location"},{"$ref":"#/components/parameters/Metadata"},{"$ref":"#/components/parameters/MoveCount"},{"$ref":"#/components/parameters/Protocol"},{"$ref":"#/components/parameters/Sets"},{"$ref":"#/components/parameters/Technology"},{"$ref":"#/components/parameters/Text"},{"$ref":"#/components/parameters/TimeLastPresent"},{"$ref":"#/components/parameters/TimeMoved"},{"$ref":"#/components/parameters/Type"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ResponseEnvelope"},{"properties":{"results":{"items":{"$ref":"#/components/schemas/Item"},"type":"array"}},"type":"object"}]}}},"description":"A JSON object containing a list of items"}},"summary":"Get all items","tags":["items"]},"post":{"operationId":"addItem","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Item"}}},"description":"A JSON object containing item information","required":true},"responses":{"200":{"$ref":"#/components/responses/OkPost"}},"summary":"Create item","tags":["items"]}},"/items/{id}":{"delete":{"operationId":"deleteItem","parameters":[{"$ref":"#/components/parameters/PathId"}],"responses":{"200":{"$ref":"#/components/responses/200OkDelete"}},"summary":"Delete item","tags":["items"]},"get":{"operationId":"getItemById","parameters":[{"$ref":"#/components/parameters/PathId"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Item"}}},"description":"A JSON object containing the items"}},"summary":"Get item","tags":["items"]},"put":{"operationId":"updateItem","parameters":[{"$ref":"#/components/parameters/PathId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemUpdate"}}},"description":"A JSON object containing item information","required":true},"responses":{"200":{"$ref":"#/components/responses/200OkPut"}},"summary":"Update existing item","tags":["items"]}},"/keys":{"get":{"description":"Can only be used by an **administrative** user.","operationId":"getKeys","parameters":[{"$ref":"#/components/parameters/After"},{"$ref":"#/components/parameters/AfterId"},{"$ref":"#/components/parameters/Before"},{"$ref":"#/components/parameters/BeforeId"},{"$ref":"#/components/parameters/From"},{"$ref":"#/components/parameters/FromId"},{"$ref":"#/components/parameters/IdOnly"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Populate"},{"$ref":"#/components/parameters/ResultsOnly"},{"$ref":"#/components/parameters/Select"},{"$ref":"#/components/parameters/Sort"},{"$ref":"#/components/parameters/Until"},{"$ref":"#/components/parameters/UntilId"},{"$ref":"#/components/parameters/TimeoutS"},{"$ref":"#/components/parameters/Id"},{"$ref":"#/components/parameters/TimeCreated"},{"$ref":"#/components/parameters/TimeUpdated"},{"description":"Filter on the secret token.","in":"query","name":"secret","schema":{"type":"string"}},{"description":"Filter on the label.","in":"query","name":"label","schema":{"type":"string"}},{"description":"Filter on read only status.","in":"query","name":"is_read_only","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ResponseEnvelope"},{"properties":{"results":{"items":{"$ref":"#/components/schemas/Key"},"type":"array"}},"type":"object"}]}}},"description":"A JSON object containing a list of keys"}},"security":[{"CookieSid":[]}],"summary":"Get all keys","tags":["keys"]},"post":{"description":"Can only be used by an **administrative** user.","operationId":"addKey","requestBody":{"$ref":"#/components/requestBodies/Key"},"responses":{"201":{"$ref":"#/components/responses/OkPost"}},"security":[{"CookieSid":[]}],"summary":"Create key","tags":["keys"]}},"/keys/{id}":{"delete":{"description":"Can only be used by an **administrative** user.","operationId":"deleteKey","parameters":[{"$ref":"#/components/parameters/PathId"}],"responses":{"200":{"$ref":"#/components/responses/200OkDelete"}},"security":[{"CookieSid":[]}],"summary":"Delete key","tags":["keys"]},"get":{"description":"Can only be used by an **administrative** user.","operationId":"getKeyById","parameters":[{"$ref":"#/components/parameters/PathId"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Key"}}},"description":"A JSON object containing the key"}},"security":[{"CookieSid":[]}],"summary":"Get key","tags":["keys"]},"put":{"description":"Can only be used by an **administrative** user.","operationId":"updateKey","parameters":[{"$ref":"#/components/parameters/PathId"}],"requestBody":{"$ref":"#/components/requestBodies/Key"},"responses":{"200":{"$ref":"#/components/responses/200OkPut"}},"security":[{"CookieSid":[]}],"summary":"Update existing key","tags":["keys"]}},"/kvpairs":{"get":{"operationId":"getKvPairs","parameters":[{"$ref":"#/components/parameters/After"},{"$ref":"#/components/parameters/AfterId"},{"$ref":"#/components/parameters/Before"},{"$ref":"#/components/parameters/BeforeId"},{"$ref":"#/components/parameters/From"},{"$ref":"#/components/parameters/FromId"},{"$ref":"#/components/parameters/IdOnly"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Populate"},{"$ref":"#/components/parameters/ResultsOnly"},{"$ref":"#/components/parameters/Select"},{"$ref":"#/components/parameters/Sort"},{"$ref":"#/components/parameters/Until"},{"$ref":"#/components/parameters/UntilId"},{"$ref":"#/components/parameters/TimeoutS"},{"$ref":"#/components/parameters/Id"},{"$ref":"#/components/parameters/TimeCreated"},{"$ref":"#/components/parameters/TimeUpdated"},{"description":"Filter on the key-value pair key value.","in":"query","name":"kv_key","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ResponseEnvelope"},{"properties":{"results":{"items":{"$ref":"#/components/schemas/KeyValuePair"},"type":"array"}},"type":"object"}]}}},"description":"A JSON object containing a list of key-value pairs"}},"summary":"Get all key-value pairs","tags":["kvpairs"]},"post":{"operationId":"addKvPairs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyValuePair"}}},"description":"A JSON object containing Key-value information","required":true},"responses":{"201":{"$ref":"#/components/responses/OkPost"}},"summary":"Create key-value pair","tags":["kvpairs"]}},"/kvpairs/{id}":{"delete":{"operationId":"deleteKvPair","parameters":[{"$ref":"#/components/parameters/PathId"}],"responses":{"200":{"$ref":"#/components/responses/200OkDelete"}},"summary":"Delete key-value pair","tags":["kvpairs"]},"get":{"operationId":"getKvPairsById","parameters":[{"$ref":"#/components/parameters/PathId"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyValuePair"}}},"description":"A JSON object containing the subscription"}},"summary":"Get key-value pair","tags":["kvpairs"]},"put":{"operationId":"updateKvPair","parameters":[{"$ref":"#/components/parameters/PathId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyValuePairUpdate"}}},"description":"A JSON object containing Key-value information","required":true},"responses":{"200":{"$ref":"#/components/responses/200OkPut"}},"summary":"Update existing Key-value pair","tags":["kvpairs"]}},"/locationrules":{"get":{"operationId":"getLocationRules","parameters":[{"$ref":"#/components/parameters/After"},{"$ref":"#/components/parameters/AfterId"},{"$ref":"#/components/parameters/Before"},{"$ref":"#/components/parameters/BeforeId"},{"$ref":"#/components/parameters/From"},{"$ref":"#/components/parameters/FromId"},{"$ref":"#/components/parameters/IdOnly"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Populate"},{"$ref":"#/components/parameters/ResultsOnly"},{"$ref":"#/components/parameters/Select"},{"$ref":"#/components/parameters/Sort"},{"$ref":"#/components/parameters/Until"},{"$ref":"#/components/parameters/UntilId"},{"$ref":"#/components/parameters/TimeoutS"},{"$ref":"#/components/parameters/Id"},{"$ref":"#/components/parameters/TimeCreated"},{"$ref":"#/components/parameters/TimeUpdated"},{"$ref":"#/components/parameters/Label"},{"$ref":"#/components/parameters/LocationRuleType"},{"$ref":"#/components/parameters/RuleEnabled"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ResponseEnvelope"},{"properties":{"results":{"items":{"$ref":"#/components/schemas/LocationRule"},"type":"array"}},"type":"object"}]}}},"description":"A JSON object containing a list of location rules"}},"summary":"Get all location rules","tags":["locationrules"]},"post":{"operationId":"addLocationRule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationRuleUpdate"}}},"description":"A JSON object containing the location rule","required":true},"responses":{"200":{"$ref":"#/components/responses/OkPost"}},"summary":"Create location rule","tags":["locationrules"]}},"/locationrules/{id}":{"delete":{"operationId":"deleteLocationRule","parameters":[{"$ref":"#/components/parameters/PathId"}],"responses":{"200":{"$ref":"#/components/responses/200OkDelete"}},"summary":"Delete location rule","tags":["locationrules"]},"get":{"operationId":"getLocationRuleById","parameters":[{"$ref":"#/components/parameters/PathId"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationRule"}}},"description":"A JSON object containing the location rule"}},"summary":"Get location rule","tags":["locationrules"]},"put":{"operationId":"updateLocationRule","parameters":[{"$ref":"#/components/parameters/PathId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationRuleUpdate"}}},"description":"A JSON object containing new properties","required":true},"responses":{"200":{"$ref":"#/components/responses/200OkPut"}},"summary":"Update existing location rule","tags":["locationrules"]}},"/locations":{"get":{"operationId":"getLocations","parameters":[{"$ref":"#/components/parameters/After"},{"$ref":"#/components/parameters/AfterId"},{"$ref":"#/components/parameters/Before"},{"$ref":"#/components/parameters/BeforeId"},{"$ref":"#/components/parameters/From"},{"$ref":"#/components/parameters/FromId"},{"$ref":"#/components/parameters/IdOnly"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Populate"},{"$ref":"#/components/parameters/ResultsOnly"},{"$ref":"#/components/parameters/Select"},{"$ref":"#/components/parameters/Sort"},{"$ref":"#/components/parameters/Until"},{"$ref":"#/components/parameters/UntilId"},{"$ref":"#/components/parameters/TimeoutS"},{"$ref":"#/components/parameters/Id"},{"$ref":"#/components/parameters/TimeCreated"},{"$ref":"#/components/parameters/TimeUpdated"},{"$ref":"#/components/parameters/Label"},{"$ref":"#/components/parameters/Metadata"},{"$ref":"#/components/parameters/Text"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ResponseEnvelope"},{"properties":{"results":{"items":{"$ref":"#/components/schemas/Location"},"type":"array"}},"type":"object"}]}}},"description":"A JSON object containing a list of locations"}},"summary":"Get all locations","tags":["locations"]},"post":{"operationId":"addLocation","requestBody":{"$ref":"#/components/requestBodies/Location"},"responses":{"201":{"$ref":"#/components/responses/OkPost"}},"summary":"Create location","tags":["locations"]}},"/locations/{id}":{"delete":{"operationId":"deleteLocation","parameters":[{"$ref":"#/components/parameters/PathId"}],"responses":{"200":{"$ref":"#/components/responses/200OkDelete"}},"summary":"Delete location","tags":["locations"]},"get":{"operationId":"getLocationById","parameters":[{"$ref":"#/components/parameters/PathId"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Location"}}},"description":"A JSON object containing the location"}},"summary":"Get location","tags":["locations"]},"put":{"operationId":"updateLocation","parameters":[{"$ref":"#/components/parameters/PathId"}],"requestBody":{"$ref":"#/components/requestBodies/Location"},"responses":{"200":{"$ref":"#/components/responses/200OkPut"}},"summary":"Update existing location","tags":["locations"]}},"/presences":{"get":{"operationId":"getPresences","parameters":[{"$ref":"#/components/parameters/After"},{"$ref":"#/components/parameters/AfterId"},{"$ref":"#/components/parameters/Before"},{"$ref":"#/components/parameters/BeforeId"},{"$ref":"#/components/parameters/From"},{"$ref":"#/components/parameters/FromId"},{"$ref":"#/components/parameters/IdOnly"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Populate"},{"$ref":"#/components/parameters/ResultsOnly"},{"$ref":"#/components/parameters/Select"},{"$ref":"#/components/parameters/Sort"},{"$ref":"#/components/parameters/Until"},{"$ref":"#/components/parameters/UntilId"},{"$ref":"#/components/parameters/TimeoutS"},{"$ref":"#/components/parameters/Id"},{"$ref":"#/components/parameters/TimeCreated"},{"$ref":"#/components/parameters/TimeUpdated"},{"$ref":"#/components/parameters/Item"},{"$ref":"#/components/parameters/Location"},{"$ref":"#/components/parameters/Proximity"},{"$ref":"#/components/parameters/Technology"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ResponseEnvelope"},{"properties":{"results":{"items":{"$ref":"#/components/schemas/Presence"},"type":"array"}},"type":"object"}]}}},"description":"A JSON object containing a list of presences"}},"summary":"Get all presences","tags":["presences"]}},"/presences/{id}":{"get":{"operationId":"getPresenceById","parameters":[{"$ref":"#/components/parameters/PathId"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Presence"}}},"description":"A JSON object containing the presence"}},"summary":"Get presence","tags":["presences"]}},"/services":{"get":{"operationId":"getServices","parameters":[{"$ref":"#/components/parameters/After"},{"$ref":"#/components/parameters/AfterId"},{"$ref":"#/components/parameters/Before"},{"$ref":"#/components/parameters/BeforeId"},{"$ref":"#/components/parameters/From"},{"$ref":"#/components/parameters/FromId"},{"$ref":"#/components/parameters/IdOnly"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Populate"},{"$ref":"#/components/parameters/ResultsOnly"},{"$ref":"#/components/parameters/Select"},{"$ref":"#/components/parameters/Sort"},{"$ref":"#/components/parameters/Until"},{"$ref":"#/components/parameters/UntilId"},{"$ref":"#/components/parameters/TimeoutS"},{"$ref":"#/components/parameters/Id"},{"$ref":"#/components/parameters/TimeCreated"},{"$ref":"#/components/parameters/TimeUpdated"},{"$ref":"#/components/parameters/Name"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ResponseEnvelope"},{"properties":{"results":{"items":{"$ref":"#/components/schemas/Service"},"type":"array"}},"type":"object"}]}}},"description":"A JSON object containing a list of services"}},"summary":"Get all services","tags":["services"]}},"/services/{id}":{"get":{"operationId":"getServiceById","parameters":[{"$ref":"#/components/parameters/PathId"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Service"}}},"description":"A JSON object containing the service"}},"summary":"Get service","tags":["services"]},"put":{"operationId":"updateService","parameters":[{"$ref":"#/components/parameters/PathId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Service"}}},"description":"A JSON object containing service information","required":true},"responses":{"200":{"$ref":"#/components/responses/200OkPut"}},"summary":"Update existing service","tags":["services"]}},"/sets/itemlists":{"get":{"operationId":"getItemLists","parameters":[{"$ref":"#/components/parameters/After"},{"$ref":"#/components/parameters/AfterId"},{"$ref":"#/components/parameters/Before"},{"$ref":"#/components/parameters/BeforeId"},{"$ref":"#/components/parameters/From"},{"$ref":"#/components/parameters/FromId"},{"$ref":"#/components/parameters/IdOnly"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Populate"},{"$ref":"#/components/parameters/ResultsOnly"},{"$ref":"#/components/parameters/Select"},{"$ref":"#/components/parameters/Sort"},{"$ref":"#/components/parameters/Until"},{"$ref":"#/components/parameters/UntilId"},{"$ref":"#/components/parameters/TimeoutS"},{"$ref":"#/components/parameters/Id"},{"$ref":"#/components/parameters/TimeCreated"},{"$ref":"#/components/parameters/TimeUpdated"},{"$ref":"#/components/parameters/Label"},{"$ref":"#/components/parameters/Metadata"},{"$ref":"#/components/parameters/Text"},{"description":"Filter based on the total amount of items in the list","example":2,"in":"query","name":"total","schema":{"type":"integer"}},{"description":"The sha1 checksum of the list. This will change when the list is mutated.","example":"92cfceb39d57d914ed8b14d0e37643de0797ae56","in":"query","name":"sha1","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ResponseEnvelope"},{"properties":{"results":{"items":{"$ref":"#/components/schemas/ItemList"},"type":"array"}},"type":"object"}]}}},"description":"A JSON object containing a list of item lists"}},"summary":"Get all item lists","tags":["sets"]},"post":{"operationId":"addItemList","requestBody":{"$ref":"#/components/requestBodies/ItemList"},"responses":{"201":{"$ref":"#/components/responses/OkPost"}},"summary":"Create item list","tags":["sets"]}},"/sets/itemlists/{id}":{"delete":{"operationId":"deleteItemSet","parameters":[{"$ref":"#/components/parameters/PathId"}],"responses":{"200":{"$ref":"#/components/responses/200OkDelete"}},"summary":"Delete item list","tags":["sets"]},"get":{"operationId":"getItemListById","parameters":[{"$ref":"#/components/parameters/PathId"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemList"}}},"description":"A JSON object containing the item list"}},"summary":"Get item list","tags":["sets"]},"put":{"operationId":"updateItemList","parameters":[{"$ref":"#/components/parameters/PathId"}],"requestBody":{"$ref":"#/components/requestBodies/ItemList"},"responses":{"200":{"$ref":"#/components/responses/200OkPut"}},"summary":"Update existing item list","tags":["sets"]}},"/sets/itemlists/{id}/ids":{"get":{"operationId":"getItemListIdsById","parameters":[{"$ref":"#/components/parameters/PathId"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOfItemIds"}}},"description":"An array object containing the item ids for this list"}},"summary":"Get item ids for this list","tags":["sets"]},"post":{"operationId":"addItemIdsList","parameters":[{"$ref":"#/components/parameters/PathId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOfItemIds"}}},"description":"A JSON array containing item ids","required":true},"responses":{"200":{"$ref":"#/components/responses/OkPostList"}},"summary":"Add items to an existing list","tags":["sets"]}},"/sets/itemlists/{id}/ids/{itemId}":{"delete":{"operationId":"deleteItemIdFromItemList","parameters":[{"$ref":"#/components/parameters/PathId"},{"description":"Item ID.","in":"path","name":"itemId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/200OkDeleteList"}},"summary":"Delete item from list","tags":["sets"]}},"/sets/spotlists":{"get":{"operationId":"getSpotLists","parameters":[{"$ref":"#/components/parameters/After"},{"$ref":"#/components/parameters/AfterId"},{"$ref":"#/components/parameters/Before"},{"$ref":"#/components/parameters/BeforeId"},{"$ref":"#/components/parameters/From"},{"$ref":"#/components/parameters/FromId"},{"$ref":"#/components/parameters/IdOnly"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Populate"},{"$ref":"#/components/parameters/ResultsOnly"},{"$ref":"#/components/parameters/Select"},{"$ref":"#/components/parameters/Sort"},{"$ref":"#/components/parameters/Until"},{"$ref":"#/components/parameters/UntilId"},{"$ref":"#/components/parameters/TimeoutS"},{"$ref":"#/components/parameters/Id"},{"$ref":"#/components/parameters/TimeCreated"},{"$ref":"#/components/parameters/TimeUpdated"},{"$ref":"#/components/parameters/Label"},{"$ref":"#/components/parameters/Metadata"},{"$ref":"#/components/parameters/Text"},{"description":"Filter based on the total amount of spots in the list","example":2,"in":"query","name":"total","schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ResponseEnvelope"},{"properties":{"results":{"items":{"$ref":"#/components/schemas/SpotList"},"type":"array"}},"type":"object"}]}}},"description":"A JSON object containing a list of spot lists"}},"summary":"Get all spot lists","tags":["sets"]},"post":{"operationId":"addSpotList","requestBody":{"$ref":"#/components/requestBodies/ItemList"},"responses":{"201":{"$ref":"#/components/responses/OkPost"}},"summary":"Create spot list","tags":["sets"]}},"/sets/spotlists/{id}":{"delete":{"operationId":"deleteSpotList","parameters":[{"$ref":"#/components/parameters/PathId"}],"responses":{"200":{"$ref":"#/components/responses/200OkDelete"}},"summary":"Delete spot list","tags":["sets"]},"get":{"operationId":"getSpotListById","parameters":[{"$ref":"#/components/parameters/PathId"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpotList"}}},"description":"A JSON object containing the spot list"}},"summary":"Info for a specific spot list","tags":["sets"]},"put":{"operationId":"updateSpotList","parameters":[{"$ref":"#/components/parameters/PathId"}],"requestBody":{"$ref":"#/components/requestBodies/SpotList"},"responses":{"200":{"$ref":"#/components/responses/200OkPut"}},"summary":"Update existing spot list","tags":["sets"]}},"/sets/spotlists/{id}/ids":{"get":{"operationId":"getSpotListIdsById","parameters":[{"$ref":"#/components/parameters/PathId"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOfItemIds"}}},"description":"An array object containing the item ids for this list"}},"summary":"Get spot ids for this list","tags":["sets"]},"post":{"operationId":"addItemIdsSpotList","parameters":[{"$ref":"#/components/parameters/PathId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOfItemIds"}}},"description":"A JSON array containing spot ids","required":true},"responses":{"200":{"$ref":"#/components/responses/OkPostList"}},"summary":"Add spots to an existing list","tags":["sets"]}},"/sets/spotlists/{id}/ids/{itemId}":{"delete":{"operationId":"deleteItemIdFromSpotList","parameters":[{"$ref":"#/components/parameters/PathId"},{"description":"Item ID.","in":"path","name":"itemId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/200OkDeleteList"}},"summary":"Delete spot from list","tags":["sets"]}},"/spots":{"get":{"operationId":"getSpots","parameters":[{"$ref":"#/components/parameters/After"},{"$ref":"#/components/parameters/AfterId"},{"$ref":"#/components/parameters/Before"},{"$ref":"#/components/parameters/BeforeId"},{"$ref":"#/components/parameters/From"},{"$ref":"#/components/parameters/FromId"},{"$ref":"#/components/parameters/IdOnly"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Populate"},{"$ref":"#/components/parameters/ResultsOnly"},{"$ref":"#/components/parameters/Select"},{"$ref":"#/components/parameters/Sort"},{"$ref":"#/components/parameters/Until"},{"$ref":"#/components/parameters/UntilId"},{"$ref":"#/components/parameters/TimeoutS"},{"$ref":"#/components/parameters/Id"},{"$ref":"#/components/parameters/TimeCreated"},{"$ref":"#/components/parameters/TimeUpdated"},{"$ref":"#/components/parameters/IsOnline"},{"$ref":"#/components/parameters/RequestCounter"},{"$ref":"#/components/parameters/SerialNumber"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ResponseEnvelope"},{"properties":{"results":{"items":{"$ref":"#/components/schemas/SpotGet"},"type":"array"}},"type":"object"}]}}},"description":"A JSON object containing a list of spots"}},"summary":"Get all spots","tags":["spots"]}},"/spots/{id}":{"get":{"operationId":"getSpotById","parameters":[{"$ref":"#/components/parameters/PathId"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpotGet"}}},"description":"A JSON object containing the spot"}},"summary":"Get spot","tags":["spots"]},"put":{"operationId":"updateSpot","parameters":[{"$ref":"#/components/parameters/PathId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpotUpdate"}}},"description":"A JSON object containing spot information","required":true},"responses":{"200":{"$ref":"#/components/responses/200OkPut"}},"summary":"Update existing spot","tags":["spots"]}},"/spots/{id}/sets":{"get":{"operationId":"getSpotSetsById","parameters":[{"$ref":"#/components/parameters/PathId"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpotSet"}}},"description":"A JSON object containing the spotset"}},"summary":"Get spotsets","tags":["spots"]},"post":{"operationId":"addSpotSet","parameters":[{"$ref":"#/components/parameters/PathId"}],"requestBody":{"$ref":"#/components/requestBodies/SpotSet"},"responses":{"201":{"$ref":"#/components/responses/OkPost"}},"summary":"Create spotset","tags":["spots"]}},"/spots/{id}/sets/{setId}":{"get":{"operationId":"getSpotSetById","parameters":[{"$ref":"#/components/parameters/PathId"},{"description":"Unique spot set identifier","example":"5b8d0b717503c445552a1865","in":"path","name":"setId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpotSet"}}},"description":"A JSON object containing the spotset"}},"summary":"Get spotset","tags":["spots"]},"put":{"operationId":"updateSpotSet","parameters":[{"$ref":"#/components/parameters/PathId"},{"description":"Unique spot set identifier","example":"5b8d0b717503c445552a1865","in":"path","name":"setId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpotSetUpdate"}}},"description":"A JSON object containing spotset information","required":true},"responses":{"200":{"$ref":"#/components/responses/200OkPut"}},"summary":"Update existing spotset","tags":["spots"]}},"/spotsets":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpotSet"}}},"description":"A JSON object containing the spotset"}},"summary":"Get spotsets","tags":["spotsets"]},"post":{"requestBody":{"$ref":"#/components/requestBodies/SpotSet"},"responses":{"201":{"$ref":"#/components/responses/OkPost"}},"summary":"Create spotset","tags":["spotsets"]}},"/spotsets/{id}":{"get":{"parameters":[{"$ref":"#/components/parameters/PathId"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpotSet"}}},"description":"A JSON object containing the spotset"}},"summary":"Get spotset","tags":["spotsets"]},"put":{"parameters":[{"$ref":"#/components/parameters/PathId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpotSetUpdate"}}},"description":"A JSON object containing spotset information","required":true},"responses":{"200":{"$ref":"#/components/responses/200OkPut"}},"summary":"Update existing spotset","tags":["spotsets"]}},"/subscriptions":{"get":{"operationId":"getSubscriptions","parameters":[{"$ref":"#/components/parameters/After"},{"$ref":"#/components/parameters/AfterId"},{"$ref":"#/components/parameters/Before"},{"$ref":"#/components/parameters/BeforeId"},{"$ref":"#/components/parameters/From"},{"$ref":"#/components/parameters/FromId"},{"$ref":"#/components/parameters/IdOnly"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Populate"},{"$ref":"#/components/parameters/ResultsOnly"},{"$ref":"#/components/parameters/Select"},{"$ref":"#/components/parameters/Sort"},{"$ref":"#/components/parameters/Until"},{"$ref":"#/components/parameters/UntilId"},{"$ref":"#/components/parameters/TimeoutS"},{"$ref":"#/components/parameters/Id"},{"$ref":"#/components/parameters/TimeCreated"},{"$ref":"#/components/parameters/TimeUpdated"},{"description":"Filter on the topic filter. Make sure to use [percent-encoding](https://en.wikipedia.org/wiki/Percent-encoding) in the query parameter.","in":"query","name":"topic_filter","schema":{"type":"string"}},{"description":"Filter based on the description.","in":"query","name":"description","schema":{"type":"string"}},{"description":"Filter based on the number of hours events are retained in the database.","in":"query","name":"database_hold_time_h","schema":{"type":"integer"}},{"description":"Filter based on subscriptions that populate the events","in":"query","name":"populate_events","schema":{"type":"boolean"}},{"description":"Filter on the verification of the target certificate.","in":"query","name":"verify_target_certificate","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ResponseEnvelope"},{"properties":{"results":{"items":{"$ref":"#/components/schemas/Subscription"},"type":"array"}},"type":"object"}]}}},"description":"A JSON object containing a list of subscriptions"}},"summary":"Get all subscriptions","tags":["subscriptions"]},"post":{"operationId":"addSubscription","requestBody":{"$ref":"#/components/requestBodies/Subscription"},"responses":{"201":{"$ref":"#/components/responses/OkPost"}},"summary":"Create subscription","tags":["subscriptions"]}},"/subscriptions/{id}":{"delete":{"operationId":"deleteSubscription","parameters":[{"$ref":"#/components/parameters/PathId"}],"responses":{"200":{"$ref":"#/components/responses/200OkDelete"}},"summary":"Delete subscription","tags":["subscriptions"]},"get":{"operationId":"getSubscriptionById","parameters":[{"$ref":"#/components/parameters/PathId"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}},"description":"A JSON object containing the subscription"}},"summary":"Get subscription","tags":["subscriptions"]},"put":{"operationId":"updateSubscription","parameters":[{"$ref":"#/components/parameters/PathId"}],"requestBody":{"$ref":"#/components/requestBodies/Subscription"},"responses":{"200":{"$ref":"#/components/responses/200OkPut"}},"summary":"Update existing subscription","tags":["subscriptions"]}},"/subscriptions/{id}/events":{"get":{"operationId":"getEventsForSubscriptionById","parameters":[{"$ref":"#/components/parameters/PathId"},{"$ref":"#/components/parameters/After"},{"$ref":"#/components/parameters/AfterId"},{"$ref":"#/components/parameters/Before"},{"$ref":"#/components/parameters/BeforeId"},{"$ref":"#/components/parameters/From"},{"$ref":"#/components/parameters/FromId"},{"$ref":"#/components/parameters/IdOnly"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Populate"},{"$ref":"#/components/parameters/ResultsOnly"},{"$ref":"#/components/parameters/Select"},{"$ref":"#/components/parameters/Sort"},{"$ref":"#/components/parameters/Until"},{"$ref":"#/components/parameters/UntilId"},{"$ref":"#/components/parameters/TimeoutS"},{"$ref":"#/components/parameters/Id"},{"$ref":"#/components/parameters/TimeCreated"},{"$ref":"#/components/parameters/TopicResourceType"},{"$ref":"#/components/parameters/TopicAction"},{"$ref":"#/components/parameters/TopicResource"},{"$ref":"#/components/parameters/TimeEvent"},{"$ref":"#/components/parameters/TimeExpire"}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ResponseEnvelope"},{"properties":{"results":{"items":{"$ref":"#/components/schemas/Event"},"type":"array"}},"type":"object"}]}}},"description":"A JSON object containing the events for a specific subscription"}},"summary":"Get subscription events","tags":["subscriptions"]}},"/users":{"get":{"description":"Can only be used by an **administrative** user.","operationId":"getUsers","parameters":[{"$ref":"#/components/parameters/After"},{"$ref":"#/components/parameters/AfterId"},{"$ref":"#/components/parameters/Before"},{"$ref":"#/components/parameters/BeforeId"},{"$ref":"#/components/parameters/From"},{"$ref":"#/components/parameters/FromId"},{"$ref":"#/components/parameters/IdOnly"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Populate"},{"$ref":"#/components/parameters/ResultsOnly"},{"$ref":"#/components/parameters/Select"},{"$ref":"#/components/parameters/Sort"},{"$ref":"#/components/parameters/Until"},{"$ref":"#/components/parameters/UntilId"},{"$ref":"#/components/parameters/TimeoutS"},{"$ref":"#/components/parameters/Id"},{"$ref":"#/components/parameters/TimeCreated"},{"$ref":"#/components/parameters/TimeUpdated"},{"description":"Filter on the email address.","in":"query","name":"email","schema":{"type":"string"}},{"description":"Filter on the first name.","in":"query","name":"first_name","schema":{"type":"string"}},{"description":"Filter on the last name.","in":"query","name":"last_name","schema":{"type":"string"}},{"description":"Filter on the administrator status.","in":"query","name":"is_admin","schema":{"type":"boolean"}},{"description":"Filter on the locked status.","in":"query","name":"is_locked","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ResponseEnvelope"},{"properties":{"results":{"items":{"$ref":"#/components/schemas/User"},"type":"array"}},"type":"object"}]}}},"description":"A JSON object containing a list of users"}},"security":[{"CookieSid":[]}],"summary":"Get all users","tags":["users"]},"post":{"description":"Can only be used by an **administrative** user.","operationId":"addUser","requestBody":{"$ref":"#/components/requestBodies/User"},"responses":{"201":{"$ref":"#/components/responses/OkPost"}},"security":[{"CookieSid":[]}],"summary":"Create user","tags":["users"]}},"/users/{id}":{"delete":{"description":"Can only be used by an **administrative** user.","operationId":"deleteUser","parameters":[{"$ref":"#/components/parameters/PathId"}],"responses":{"200":{"$ref":"#/components/responses/200OkDelete"}},"security":[{"CookieSid":[]}],"summary":"Delete user","tags":["users"]},"get":{"description":"Can only be used by an **administrative** user.","operationId":"getUserById","parameters":[{"$ref":"#/components/parameters/PathId"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"A JSON object containing the user"}},"security":[{"Cooki