# Модуль decort_user_info ## Обзор модуля Модуль **decort_user_info** предназначен для получения следующей информации о пользователе: - **основная информация** (см. [возвращаемые значения](#основная-информация) и [примеры](#получение-основной-информации-о-пользователе)) - **используемые и зарезервированные ресурсы** (см. [параметр resource_consumption](#resource_consumption), [возвращаемые значения](#используемые-и-зарезервированные-ресурсы) и [примеры](#получение-информации-об-используемых-и-зарезервируемых-ресурсах)) - **доступные аккаунты** (см. [параметр accounts](#accounts), [возвращаемые значения](#доступные-аккаунты) и [примеры](#получение-информации-о-доступных-аккаунтах)) - **аудиты** (см. [параметр audits](#audits), [возвращаемые значения](#аудиты) и [примеры](#получение-информации-об-аудитах)) - **доступные методы API** (см. [параметр api_methods](#api_methods), [возвращаемые значения](#доступные-методы-api) и [примеры](#получение-доступных-методов-api)) - **поиск доступных объектов по строке** (см. [параметр objects_search](#objects_search), [возвращаемые значения](#найденные-объекты) и [примеры](#поиск-доступных-объектов)) ## Параметры модуля Ниже приведен список параметров для модуля **decort_user_info** (за исключением [общих параметров авторизации](./введение.md#общие-параметры-модулей-для-авторизации)):

Параметр					Тип	Описание
accounts					(dict)	Получить информацию об аккаунтах, к которым имеет доступ пользователь, с учётом заданных параметров вывода. Чтобы получить информацию без указания параметров вывода, необходимо задать пустой словарь `{}`.
	deleted				(bool) Default: `false`	`false` - вывод только неудалённых объектов. `true` - вывод только удалённых в корзину объектов.
	filter				(dict)	Фильтр.
		rights			(str) Значения: `R` `RCX` `ARCXDU` `CXDRAU`	По предоставленным правам доступа.
		id			(int)	По идентификатору.
		name			(str)	По имени.
		status			(str) Значения: `CONFIRMED` `DELETED` `DESTROYED` `DESTROYING` `DISABLED`	По статусу.
	pagination				(dict)	Постраничный вывод.
		number			(int) Default: `1`	Номер страницы.
		size			(int)	Размер страниц. Обязательный параметр.
	resource_consumption				(bool) Default: `false`	Получить информацию об используемых и зарезервированных ресурсах.
	sorting				(dict)	Сортировка.
		asc			(bool) Default: `true`	Сортировать по возрастанию. `true` - по возрастанию. `false` - по убыванию.
		field			(str) Значения: `createdTime` `deletedTime` `id` `name` `status` `updatedTime`	Название поля, по которому сортировать. Обязательный параметр.
api_methods					(bool) Default: `false`	Получить методы API, к которым имеет доступ пользователь.
audits					(dict)	Получить информацию об аудитах пользователя, с учётом заданных параметров вывода. Чтобы получить информацию с параметрами вывода по умолчанию, необходимо задать пустой словарь `{}`.
	filter				(dict)	Фильтр.
		api_method			(str)	По методу API.
		status_code			(dict)	По коду ответа HTTP.
			min		(int)	По минимальному коду ответа HTTP.
			max		(int)	По максимальному коду ответа HTTP.
		time			(dict)	По временному периоду.
			start		(dict)	Начало периода.
				unix	(int)	Unix-время.
				date_time	(str)	Дата и время в формате `ггггммддччммсс`. Альтернатива параметру `unix`. Допустимо использовать любой разделитель между группами цифр для повышения читаемости. Например, `гггг-мм-дд чч:мм:сс`.
			end		(dict)	Конец периода. Структура словаря аналогична параметру `start`.
	pagination				(dict)	Постраничный вывод.
		number			(int) Default: `1`	Номер страницы.
		size			(int) Default: `50`	Размер страниц.
objects_search					(str)	Получить информацию о доступных пользователю объектах, найденных по строчному значению данного параметра.
resource_consumption					(bool) Default: `false`	Получить информацию об используемых и зарезервированных ресурсах, к которым имеет доступ пользователь.

## Возвращаемые значения Модуль **decort_user_info** возвращает информацию о пользователе в виде словаря `facts` со следующими ключами: ### Основная информация

Ключ	Тип данных	Описание
admin	bool	Наличие административных прав.
data	dict	Дополнительные данные.
emailaddresses	list	Адреса эл. почты.
name	str	Имя/идентификатор.
roles	list	Группы доступа.

### Используемые и зарезервированные ресурсы

Ключ					Тип данных	Описание
resource_consumed					dict	Используемые ресурсы.
	cpu				int	Количество виртуальных процессоров.
	disksize				int	Объём дисков в ГБ.
	extips				int	Количество внешних IP-адресов.
	exttraffic				int	Объём трафика внешних сетей.
	gpu				int	Количество графических процессоров.
	ram				int	Объём оперативной памяти в МБ.
	seps				dict	Объём дисков по пулам СХД.
		(идентификатор СХД)			dict	Пулы СХД.
			(название пула)		dict	Словарь пула СХД.
				disksize	int	Объём дисков в ГБ.
resource_reserved					dict	Зарезервированные ресурсы. Структура словаря аналогична словарю resource_consumed .

### Доступные аккаунты

Ключ			Тип данных	Описание
accounts			list	Список словарей, описывающих аккаунты.
	acl		list	Список словарей, описывающих доступы пользователей.
		right	str	Права доступа.
		status	str	Статус.
		type	str	Тип.
		userGroupId	str	Идентификатор пользователя или группы пользователей.
	computeFeatures		list	Список дополнительных возможностей гипервизора, доступных ВМ.
	createdTime		int	Unix-время создания.
	createdTime_readable		str	Дата и время создания.
	deletedTime		int	Unix-время удаления.
	deletedTime_readable		str	Дата и время удаления.
	id		int	Идентификатор.
	name		str	Имя.
	resource_consumed		list	Используемые ресурсы. Только если `accounts.resource_consumption: true` и только для неудалённых объектов. Структура словаря аналогична словарю resource_consumed .
	resource_reserved		list	Зарезервированные ресурсы. Только если `accounts.resource_consumption: true` и только для неудалённых объектов. Структура словаря аналогична словарю resource_consumed .
	status		str	Статус.
	updatedTime		int	Unix-время обновления.
	updatedTime_readable		str	Дата и время обновления.

### Аудиты

Ключ		Тип данных	Описание
audits		list	Список словарей, описывающих аудиты.
	Call	str	Метод API.
	Guid	str	Уникальный идентификатор аудита.
	Response Time	float	Время отклика в секундах.
	Status Code	int	Код ответа HTTP.
	Time	float	Unix-время.
	Time_readable	str	Дата и время.

### Доступные методы API

Ключ			Тип данных	Описание
api_methods			list	Список словарей, описывающих доступные методы API.
	(название группы методов API)		dict	Доступные методы группы.
		(название подгруппы методов API)	list	Методы подгруппы.
		ALL	bool	Доступ ко всем методам группы.

### Найденные объекты

Ключ						Тип данных	Описание
objects_search						list	Список словарей, описывающих найденные объекты.

## Примеры использования ### Получение основной информации о пользователе ``` - name: Example hosts: localhost tasks: - name: Get basic user info decort_user_info: # Параметры для авторизации упущены ``` ### Получение информации об используемых и зарезервируемых ресурсах ``` - name: Example hosts: localhost tasks: - name: Get user info with resource consumption decort_user_info: # Параметры для авторизации упущены resource_consumption: true ``` ### Получение информации о доступных аккаунтах #### Только неудалённые ``` - name: Example hosts: localhost tasks: - name: Get user info with not deleted accounts decort_user_info: # Параметры для авторизации упущены accounts: {} ``` #### Только удалённые в корзину ``` - name: Example hosts: localhost tasks: - name: Get user info with deleted accounts decort_user_info: # Параметры для авторизации упущены accounts: deleted: true ``` #### С информацией об используемых и зарезервированных ресурсах ``` - name: Example hosts: localhost tasks: - name: Get user info with accounts decort_user_info: # Параметры для авторизации упущены accounts: resource_consumption: true ``` #### С фильтрацией по статусу ``` - name: Example hosts: localhost tasks: - name: Get user info with accounts decort_user_info: # Параметры для авторизации упущены accounts: filter: status: CONFIRMED ``` #### С сортировкой по имени ``` - name: Example hosts: localhost tasks: - name: Get user info with accounts decort_user_info: # Параметры для авторизации упущены accounts: sorting: field: name ``` #### С постраничным выводом ``` - name: Example hosts: localhost tasks: - name: Get user info with accounts decort_user_info: # Параметры для авторизации упущены accounts: pagination: size: 2 ``` ### Получение информации об аудитах #### Без использования параметров вывода ``` - name: Example hosts: localhost tasks: - name: Get user info with audits decort_user_info: # Параметры для авторизации упущены audits: {} ``` #### С фильтрацией по методу API ``` - name: Example hosts: localhost tasks: - name: Get user info with audits decort_user_info: # Параметры для авторизации упущены audits: filter: call: cloudapi/account ``` #### С фильтрацией по временному периоду ``` - name: Example hosts: localhost tasks: - name: Get user info with audits decort_user_info: # Параметры для авторизации упущены audits: filter: time: start: unix: 1724668267 end: date_time: 2024-08-26_13-40 ``` #### С постраничным выводом ``` - name: Example hosts: localhost tasks: - name: Get user info with audits decort_user_info: # Параметры для авторизации упущены audits: pagination: size: 2 ``` ### Получение доступных методов API ``` - name: Example hosts: localhost tasks: - name: Get user info with API methods decort_user_info: # Параметры для авторизации упущены api_methods: true ``` ### Поиск доступных объектов ``` - name: Example hosts: localhost tasks: - name: Get user info with found objects decort_user_info: # Параметры для авторизации упущены objects_search: test ```