membership#

Autogenerated API

argus_api.lib.useradmin.v2.membership.list_memberships(subject: str = None, limit: int = 25, 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 group memberships (PUBLIC)

Parameters

  • subject (list) – Filter out by user or group (by ID or shortname)

  • limit (int) – Maximum number of returned results

  • offset (int) – Skip a number of results

  • includeDeleted (bool) – Include deleted memberships

  • 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.membership.remove_memberships_bulk(membershipID: str = None, comment: 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#

Delete set of memberships (PUBLIC)

Parameters

  • membershipID (list) – IDs of memberships to delete

  • comment (str) – Comment to describe the reason for this change

  • 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.membership.search_memberships(subCriteria: dict = None, subject: str = None, subjectFieldStrategy: str = None, startTimestamp: str = None, endTimestamp: str = None, timeFieldStrategy: str = None, timeMatchStrategy: str = None, customer: str = None, domain: str = None, sortBy: str = None, includeDeleted: bool = 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#

Search for group memberships (PUBLIC)

Parameters

  • subCriteria (list) –

  • subject (list) – Filter out memberships by subject (by ID or shortname). Se subjectFieldStrategy.

  • subjectFieldStrategy (list) – Determine fields to search for subjects by (defaults to groups and members)

  • startTimestamp (str) – Restrict search to data after this time (epoch millis) according to selected TimeFieldStrategies. Allows unix timestamp (milliseconds), ISO timestamp, or relative time specifies. See https://docs.mnemonic.no/x/AQDXAQ

  • endTimestamp (str) – Restrict search to data before this time (epoch millis) according to selected TimeFieldStrategies. Allows unix timestamp (milliseconds), ISO timestamp, or relative time specifies. See https://docs.mnemonic.no/x/AQDXAQ

  • timeFieldStrategy (list) – Determine fields to search for subjects by (defaults to groups and members)

  • timeMatchStrategy (str) – Specify if the specified time period must match all the searched time fields, or if it will match for any field. Default is any.

  • customer (list) – Filter out memberships where any of these customers are owning either the group or the member (by ID or shortname)

  • domain (str) – When providing subjects or customers, lookup subjects or customers within this domain. If not specified, subjects and customers will be looked up in the current users domain.

  • sortBy (list) – Field to sort result by (default groupShortName)

  • includeDeleted (bool) – Include deleted memberships (default false)

  • 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

dictionary translated from JSON