customer#

Autogenerated API

argus_api.lib.customeradmin.v2.customer.add_customer(name: str = None, shortName: str = None, domain: str = None, parent: str = None, language: str = None, timeZone: str = None, type: str = None, excludeFromProduction: bool = None, networkBaseCustomer: bool = None, singleNetworkDomain: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Create a new customer (PUBLIC)

Parameters

  • name (str) – Name of the new customer => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • shortName (str) – Short name of the new customer => [a-zA-Z0-9_:\-.]*

  • domain (str) – Domain of the parent. If not set, the parent will be resolved in the current users domain.

  • parent (str) – Short name or id of the customers parent.

  • language (str) – Preferred language.

  • timeZone (str) – Customer’s timezone id or string. Defaults to Europe/Oslo.

  • type (str) – Type of customer.

  • excludeFromProduction (bool) – Mark customer as excluded from production. (default false)

  • networkBaseCustomer (bool) – Whether enable customer as base customer for a customer group, used for remapping events’ customer by network CIDR among sub-customers that belong to same customer group (group must be SINGLE_NETWORK_DOMAIN flagged), cannot be set for group customer, and once enabled the customer cannot be promoted to group unless disable it. (default false)

  • singleNetworkDomain (bool) – Whether enable customer group option for remapping events’ customer by network CIDR among its sub-customers, cannot be set for non-group customer, and once enabled the customer group cannot be changed to non-group customer unless disable it. (default false)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.customeradmin.v2.customer.disable_customer(idOrShortName: str, domain: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Disable customer. (PUBLIC)

Parameters

  • idOrShortName (str) – Customer id or shortname

  • domain (str) – Customer domain

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.customeradmin.v2.customer.get_customer(idOrShortName: str, domain: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Returns a Customer identified by its ID or short name. (PUBLIC)

Parameters

  • idOrShortName (str) – Customer ID or short name

  • domain (str) – Customer domain to lookup short name (defaults to current users domain)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

Returns a Customer logo by customer shortname or id. (PUBLIC)

Parameters

  • idOrShortName (str) – Customer ID or shortName

  • domain (str) – Customer domain to lookup shortname (defaults to current users domain)

  • size (str) – The max size of the logo (small, medium, large, xlarge). Will resize the logo within the selected size, retaining aspect ratio.

  • includeDefault (bool) – Include default logo

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

requests.Response object

argus_api.lib.customeradmin.v2.customer.get_customer_properties(idOrShortName: str, domain: str = None, key: str = None, section: str = None, limit: int = 25, offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Returns a set of properties for the customer id or shortName by property name. (PUBLIC)

Parameters

  • idOrShortName (str) – Customer ID or shortName

  • domain (str) – Customer domain to lookup shortname (defaults to current users domain)

  • key (list) – Filter for specific properties.

  • section (list) – Filter for properties in specific sections.

  • limit (int) – Maximum number of returned results

  • offset (int) – By how many records to offset results

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.customeradmin.v2.customer.get_customer_user_roles(idOrShortName: str, domain: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Returns a set of User roles for the customer id or shortName. (PUBLIC)

Parameters

  • idOrShortName (str) – Customer ID or shortName

  • domain (str) – Customer domain to lookup user (defaults to current users domain)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.customeradmin.v2.customer.list_customers(parent: str = None, keywords: str = None, sortBy: str = None, limit: int = 25, offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Returns customers defined by query parameters (PUBLIC)

Parameters

  • parent (list) – Search by parent id or shortName

  • keywords (list) – Search by keywords

  • sortBy (list) – Sort search result

  • limit (int) – Maximum number of returned results

  • offset (int) – By how many records to offset results

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.customeradmin.v2.customer.move_customer(idOrShortName: str, domain: str = None, parent: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Move customer to a different parent. (PUBLIC)

Parameters

  • idOrShortName (str) – Customer ID or shortname

  • domain (str) – ID or shortname of domain to lookup customer in

  • parent (str) – The name or ID of the new parent to move the customer to.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.customeradmin.v2.customer.prune_customer_data(idOrShortName: str, domain: str = None, token: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Trigger customer data pruning. (PUBLIC)

Parameters

  • idOrShortName (str) – Customer id or shortname

  • domain (str) – Customer domain

  • token (str) – Authorization token

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.customeradmin.v2.customer.reenable_customer(idOrShortName: str, domain: str = None, empty: bool = None, present: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Reenable customer. (PUBLIC)

Parameters

  • idOrShortName (str) – Customer ID or shortname

  • domain (str) – Customer domain

  • empty (bool) –

  • present (bool) –

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.customeradmin.v2.customer.remove_customer_properties(idOrShortName: str, key: str, domain: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Returns a set of all current properties for the customer id or shortName, after the values for specified keys have been deleted. (PUBLIC)

Parameters

  • idOrShortName (str) – Customer ID or short name, used to identify customer.

  • key (list) – Set of property keys to be deleted

  • domain (str) – Domain ID or short name, used to identify customer. Defaults to current user’s domain.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.customeradmin.v2.customer.search_customers(customer: str = None, ancestor: str = None, parent: str = None, domain: str = None, type: str = None, includeFlags: str = None, excludeFlags: str = None, keywords: str = None, keywordMatchStrategy: str = None, keywordFieldStrategy: str = None, subCriteria: dict = None, includeDeleted: bool = None, limit: int = None, offset: int = None, sortBy: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Returns customers defined by SearchAdminCustomerRequest (PUBLIC)

Parameters

  • customer (list) – Restrict search to specified customers.

  • ancestor (list) – Search for customers by ancestor customer id or shortname. Will return customers that descend from any of these parents.

  • parent (list) – Search for customers by parent customer id or shortname. Will return customers that are direct children of any of these parents.

  • domain (list) – Search for customers in one of these domains (by domain id or name).

  • type (list) – Search for customers by type.

  • includeFlags (list) – Only include objects which have includeFlags set.

  • excludeFlags (list) – Exclude objects which have excludeFlags set.

  • keywords (list) – Search for customers by keywords.

  • keywordMatchStrategy (str) – Defines the MatchStrategy for keywords (default match all keywords).

  • keywordFieldStrategy (list) – Defines which fields will be searched by keywords (default all supported fields).

  • subCriteria (list) – Set additional criteria

  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.

  • limit (int) – Max number of results.

  • offset (int) – Skip the first (offset) objects. By default, return result from first object.

  • sortBy (list) – Field to sort result by, use - to sort in desc order. (default id)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.customeradmin.v2.customer.update_customer(idOrShortName: str, domain: str = None, name: str = None, shortName: str = None, language: str = None, timeZone: str = None, denySubmitForAnonymousUser: bool = None, allowGlobalData: bool = None, excludeFromProduction: bool = None, networkBaseCustomer: bool = None, singleNetworkDomain: bool = None, dataDeleted: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Update a customer object. (PUBLIC)

Parameters

  • idOrShortName (str) – Customer ID or short name, used to identify customer.

  • domain (str) – Domain ID or short name, used to identify customer. Defaults to current user’s domain.

  • name (str) – If set, change customer name to this value. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • shortName (str) – If set, change customer shortname to this value (must be unique). => [a-zA-Z0-9_:\-.]*

  • language (str) – If set, change customer language.

  • timeZone (str) – If set, change customer timezone to timezone with this name.

  • denySubmitForAnonymousUser (bool) – It is possible to modify this flag only for leaf customers.

  • allowGlobalData (bool) – It is possible to modify this flag only for leaf customers.

  • excludeFromProduction (bool) – If set, enable/disable customer as excluded from production

  • networkBaseCustomer (bool) – If set, enable/disable customer as base customer for a customer group, used for remapping events’ customer by network CIDR among sub-customers that belong to same customer group (group must be SINGLE_NETWORK_DOMAIN flagged), cannot be set for group customer, and once enabled the customer cannot be promoted to group unless disable it.

  • singleNetworkDomain (bool) – If set, enable/disable customer group option for remapping events’ customer by network CIDR among its sub-customers, cannot be set for non-group customer, and once enabled the customer group cannot be changed to non-group customer unless disable it.

  • dataDeleted (bool) – If set, this option indicates that all of Customer data has been deleted. Please do not set this flag if you did not confirm that the customers data has been purged. Setting this option will not delete the data. It is for indication purposes only.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

Updates a customer logo image (PUBLIC)

Parameters

  • idOrShortName (str) – Short name or ID of customer

  • domain (str) – Name or ID of the domain of the user

  • image (str) – Change customer logo. Base64 data String. Example: ‘data:image/png;base64, iVBORw0KGgoAAAA…’, please provide only the ‘iVBORw0KGgoAAAA…’ part.

  • data (str) – Change customer logo. Must be image bytes in the format specified by mimeType.

  • mimeType (str) – The MIME type of the image. Currently allowed mimetypes are image/png and image/jpg

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.customeradmin.v2.customer.update_customer_properties(idOrShortName: str, domain: str = None, properties: dict = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Returns a set of only the updated properties (not all of the properties) for the customer id or shortName by property name. (PUBLIC)

Parameters

  • idOrShortName (str) – Customer ID or short name, used to identify customer.

  • domain (str) – Domain ID or short name, used to identify customer. Defaults to current user’s domain.

  • properties (dict) – Set of properties to update with corresponding values.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.customeradmin.v2.customer.update_customer_user_roles(idOrShortName: str, domain: str = None, userRoles: dict = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Update user roles of a customer object. (PUBLIC)

Parameters

  • idOrShortName (str) – Customer ID or shortname

  • domain (str) – Customer domain to lookup user (defaults to current users domain)

  • userRoles (list) – Set of users and roles to update in json format

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON