user#

Autogenerated API

argus_api.lib.useradmin.v2.user.add_user(customer: str = None, shortName: str = None, name: str = None, description: str = None, email: str = None, phoneNumber: str = None, phone: dict = None, role: str = None, language: str = None, externallyManaged: bool = None, daemonAccount: bool = None, skipDefaultAuthenticationMethods: 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#

Add new user (PUBLIC)

Parameters

  • customer (str) – The shortname or ID for customer to register the subject to

  • shortName (str) – The shortname of the subject => Sanitize by regex [a-zA-Z0-9_\-.@]+

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

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

  • email (str) – The user’s email => format:email

  • phoneNumber (str) – DEPRECATED: Use phone instead. The user’s phone number. Gives an error if used with phoneNumber => format:phone

  • phone (dict) –

  • role (str) – DEPRECATED: Use ‘description’ field instead.

  • language (str) – The user’s language (default english)

  • externallyManaged (bool) – Whether the subject is managed externally (default false)

  • daemonAccount (bool) – If set, mark this account as a daemon account (default false)

  • skipDefaultAuthenticationMethods (bool) – If set, skip adding default authentication methods (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.useradmin.v2.user.admin_get_user_image(shortNameOrID: str, domain: str = None, size: str = None, width: int = None, height: int = None, default: 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) → requests.models.Response#

Returns user profile picture. (PUBLIC)

Parameters

  • shortNameOrID (str) – User ID or username

  • domain (str) – Domain ID or shortname (optional, defaults to current user domain)

  • size (str) – The preferred size of the image (small, medium, large, xlarge), should not be used together with parameters ‘width’ and ‘height’, will crop the original image if it is not a square (optional)

  • width (int) – The preferred width of the image. Preserves aspect ratio if height is not set (optional)

  • height (int) – The preferred height of the image. Preserves aspect ratio if width is not set (optional)

  • default (bool) – If true, return default avatar image if user picture not set. Default is 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

requests.Response object

argus_api.lib.useradmin.v2.user.delete_user(shortNameOrID: 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#

Deletes a user (PUBLIC)

Parameters

  • shortNameOrID (str) – Short name or ID of user

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

  • 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.useradmin.v2.user.delete_user_1(shortNameOrID: 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#

DEPRECATED : delete_user_1 is an alias for delete_user. Exists only for backward compatibility - do not use - use delete_user instead.

argus_api.lib.useradmin.v2.user.delete_user_preferences(shortNameOrID: str, domain: str = None, key: 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#

Deletes selected user preferences (PUBLIC)

Parameters

  • shortNameOrID (str) – Short name or ID of subject

  • domain (str) – Domain ID or short name (optional, defaults to current user domain)

  • key (list) – Name of preference to delete

  • 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.useradmin.v2.user.get_user(shortNameOrID: 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#

Get a user (PUBLIC)

Parameters

  • shortNameOrID (str) – Short name or ID of user

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

  • 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.useradmin.v2.user.get_user_image_1(shortNameOrID: str, domain: str = None, size: str = None, width: int = None, height: int = None, default: 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) → requests.models.Response#

DEPRECATED : get_user_image_1 is an alias for admin_get_user_image. Exists only for backward compatibility - do not use - use admin_get_user_image instead.

argus_api.lib.useradmin.v2.user.get_user_preference(shortNameOrID: 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#

Return the preference with the given key (PUBLIC)

Parameters

  • shortNameOrID (str) – Short name or ID of subject

  • key (str) – Name of preference to return

  • domain (str) – Domain ID or short name (optional, defaults to current user 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.useradmin.v2.user.list_permissions_for_user(shortNameOrID: str, domain: str = None, limit: int = 25, includeInherited: bool = True, offset: int = None, includeDeleted: 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#

List permissions for a user (PUBLIC)

Parameters

  • shortNameOrID (str) – Short name or ID of user

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

  • limit (int) – Maximum number of returned results

  • includeInherited (bool) – Include inherited permission

  • offset (int) – Skip a number of results

  • includeDeleted (bool) – Include deleted permission

  • 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.useradmin.v2.user.list_user_preference_as_map(shortNameOrID: str, domain: str = None, key: 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#

Lists out the user’s preferences. Returns all user preferences if no keys are specified (PUBLIC)

Parameters

  • shortNameOrID (str) – Short name or ID of subject

  • domain (str) – Domain ID or short name (optional, defaults to current user domain)

  • key (list) – List of preferences to return, default is all

  • limit (int) – Maximum number of returned results

  • offset (int) – Skip a number of 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.useradmin.v2.user.list_user_preferences(shortNameOrID: str, domain: str = None, key: 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#

Lists out the user’s preferences. Returns all user preferences if no keys are specified (PUBLIC)

Parameters

  • shortNameOrID (str) – Short name or ID of subject

  • domain (str) – Domain ID or short name (optional, defaults to current user domain)

  • key (list) – List of preferences to return, default is all

  • limit (int) – Maximum number of returned results

  • offset (int) – Skip a number of 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.useradmin.v2.user.list_users(domain: str = None, subject: str = None, customer: str = None, excludeFlag: str = None, includeFlag: str = None, keyword: str = None, keywords: str = None, keywordField: str = None, sortBy: str = None, limit: int = 25, keywordMatch: str = 'all', offset: int = None, includeDeleted: 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#

Returns the users matching the query (PUBLIC)

Parameters

  • domain (list) – Domain to search in by short name or id

  • subject (list) – Subject to search for by short name or id

  • customer (list) – Customer to search for by short name or id

  • excludeFlag (list) – Exclude users with flag

  • includeFlag (list) – Include users with flag

  • keyword (list) – DEPRECATED: Use ‘keywords’ instead

  • keywords (list) – Search by keywords

  • keywordField (list) – Set field strategy for keyword search

  • sortBy (list) – Field to sort by

  • limit (int) – Maximum number of returned results

  • keywordMatch (str) – Set match strategy for keyword search

  • offset (int) – Skip a number of results

  • includeDeleted (bool) – Include deleted users

  • 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.useradmin.v2.user.list_users_1(domain: str = None, subject: str = None, customer: str = None, excludeFlag: str = None, includeFlag: str = None, keyword: str = None, keywords: str = None, keywordField: str = None, sortBy: str = None, limit: int = 25, keywordMatch: str = 'all', offset: int = None, includeDeleted: 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#

DEPRECATED : list_users_1 is an alias for list_users. Exists only for backward compatibility - do not use - use list_users instead.

argus_api.lib.useradmin.v2.user.move_user(shortNameOrID: str, domain: str = None, customer: 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 a user to another customer (PUBLIC)

Parameters

  • shortNameOrID (str) – Short name or ID of user

  • domain (str) – Domain ID or short name (optional, defaults to current user domain)

  • customer (str) – ID or shortname of customer to move the subject to. The customer must be in same domain as the subject.

  • 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.useradmin.v2.user.reenable_user(shortNameOrID: 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#

Reenables a deleted user (PUBLIC)

Parameters

  • shortNameOrID (str) – Short name or ID of user

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

  • 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.useradmin.v2.user.reset_password(shortNameOrID: 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#

Resets a users password. This operation is deprecated, use /authentication/v1/user/{user}/password/reset instead. (PUBLIC)

Parameters

  • shortNameOrID (str) – Short name or ID of user

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

  • 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.useradmin.v2.user.search_users(domain: str = None, subject: str = None, ancestor: str = None, parent: str = None, customer: str = None, sortBy: str = None, includeFlags: str = None, excludeFlags: str = None, permissions: dict = None, keywords: str = None, keywordMatchStrategy: str = None, keywordFieldStrategy: str = None, endTimestamp: int = None, timeMatchStrategy: str = None, timeFieldStrategy: str = None, subCriteria: dict = None, userPreferences: dict = None, includeDeleted: bool = None, startTimestamp: int = 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 the users matching the query (PUBLIC)

Parameters

  • domain (list) – Restrict the search to subjects in these domains, by domain ID or name.

  • subject (list) – Restrict search to specific subjects, by ID or shortname

  • ancestor (list) – Restrict search to subjects descending from specific groups, by ID or shortname. This will not include deleted ancestors if includeDeleted is set

  • parent (list) – Restrict search to subjects which are direct member of specific groups, by ID or shortname

  • customer (list) – Restrict search to subjects bound to these customers (by ID or shortname). Customer groups will resolve to all sub customers as well.

  • sortBy (list) – Field to sort by (default name)

  • includeFlags (list) – Restrict search to subjects having all of the specified flags.

  • excludeFlags (list) – Exclude subjects with these flags from the search.

  • permissions (list) – Limit search to subjects with one of the given permissions

  • keywords (list) – Keywords to search for

  • keywordMatchStrategy (str) – Search based on all keywords (AND), or based on any keyword (OR) (default Match all keywords (AND))

  • keywordFieldStrategy (list) – Which fields will be searched for the given keyword (default All supported fields)

  • endTimestamp (int) – The end time of the search (default now)

  • timeMatchStrategy (str) – Search based on all time-field (AND), or based on any time-field (OR) (default Match any field)

  • timeFieldStrategy (list) – The fields to limit the time search to (default All fields)

  • subCriteria (list) – Set additional criteria with AND, OR or AND NOT

  • userPreferences (dict) – Restricts the search to users with matching user preferences. The key should be the name of the user preference. The UserPreferenceSearchSubCriteria can provide value, or if the preference should be included or excluded

  • includeDeleted (bool) – Whether or not to include deleted subjects. This will include deleted groups and users (default false)

  • startTimestamp (int) – The start time of the search (default 0)

  • limit (int) – The max amount of items to display (default 25)

  • offset (int) – The amount of items to skip (default 0)

  • 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 or dictionary translated from JSON

argus_api.lib.useradmin.v2.user.set_user_image(shortNameOrID: str, domain: str = None, image: str = None, mimeType: 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#

Sets a users profile image (PUBLIC)

Parameters

  • shortNameOrID (str) – Short name or ID of user

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

  • image (str) – The image to upload (in base64)

  • mimeType (str) – The MIME type of the image

  • 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.useradmin.v2.user.set_user_preference(shortNameOrID: str, key: str, value: 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#

Update the user’s preferences (PUBLIC)

Parameters

  • shortNameOrID (str) – Short name or ID of subject

  • key (str) – Name of preference to set

  • value (str) – Value of the preference to set

  • domain (str) – Domain ID or short name (optional, defaults to current user 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.useradmin.v2.user.set_user_preferences(shortNameOrID: 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#

Update the user’s preferences (PUBLIC)

Parameters

  • shortNameOrID (str) – Short name or ID of subject

  • domain (str) – Domain ID or short name (optional, defaults to current user 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.useradmin.v2.user.unblock_user(shortNameOrID: 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#

Unblocks a user. This endpoint is deprecated, use /authentication/v1/user/{user}/unblock instead. (PUBLIC)

Parameters

  • shortNameOrID (str) – Short name or ID of user

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

  • 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.useradmin.v2.user.update_user(shortNameOrID: str, domain: str = None, shortName: str = None, name: str = None, description: str = None, externallyManaged: bool = None, email: str = None, phoneNumber: str = None, phone: dict = None, role: str = None, language: str = None, daemonAccount: 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 user (PUBLIC)

Parameters

  • shortNameOrID (str) – Short name or ID of user

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

  • shortName (str) – The shortname of the subject => Sanitize by regex [a-zA-Z0-9_\-.@]+

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

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

  • externallyManaged (bool) – Whether the subject is managed externally

  • email (str) – If set, update the user’s email. Blank string will delete the current value. => format:email

  • phoneNumber (str) – DEPRECATED: Use phone instead. If set, update the user’s phone number. Gives an error if used with phone => format:phone

  • phone (dict) –

  • role (str) – DEPRECATED: Use ‘description’ field instead.

  • language (str) – If set, change the user’s language

  • daemonAccount (bool) – If set, change the daemon flag for this user

  • 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