Spec-Zone.ru › AWS CLI v2

[ aws . ds-data ]

describe-user

Описание

Возвращает информацию о конкретном пользователе.

См. также: Документацию API AWS

Синтаксис

  describe-user
--directory-id <value>
[--other-attributes <value>]
[--realm <value>]
--sam-account-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--directory-id (строка)

Идентификатор (ID) каталога, связанного с пользователем.

--other-attributes (список)

Одно или несколько имён атрибутов, которые должны быть возвращены для пользователя. Ключ — имя атрибута, а значение — список карт. Список поддерживаемых атрибутов см. в разделе Атрибуты данных службы каталогов.

(строка)

Синтаксис:

"string" "string" ...

--realm (строка)

Имя домена, связанное с пользователем.

Примечание

Этот параметр необязательный, поэтому вы можете возвращать пользователей, не относящихся к вашему управляемому домену Microsoft AD. Если значение не определено, возвращаются только пользователи вашего управляемого домена Microsoft AD.

Это значение не чувствительно к регистру.

--sam-account-name (строка)

Имя пользователя.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, указанному в --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные в JSON. Передавать произвольные двоичные значения с помощью JSON-предоставленного значения невозможно, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено значение без значения или значение input, выводится пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, будет напечатан пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно проверяет входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантии обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (булево)

Включить отладку.

--endpoint-url (строка)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (булево)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого соединения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.

--no-paginate (булево)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команд.

  • json
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет параметры конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • вкл
  • выкл
  • авто

--no-sign-request (булево)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Сборник сертификатов CA для использования при проверке сертификатов SSL. Переопределяет параметры конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде строки, закодированной в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого файла, которое отображается как двоичный блок fileb:// всегда будет обрабатываться как двоичное и использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (булево)

Отключить пагинатор CLI для вывода.

--cli-auto-prompt (булево)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запросы параметров ввода CLI.

Примеры

Примечание

Для использования следующих примеров вам необходимо установить и настроить AWS CLI. Более подробную информацию см. в руководстве по началу работы в справочнике пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования, похожие на unix. Эти примеры необходимо адаптировать к правилам цитирования вашего терминала. Смотрите раздел «Использование кавычек со строками» в руководстве пользователя AWS CLI.

Чтобы вывести информацию о пользователе

Следующий describe-user пример получает информацию о заданном пользователе в заданном каталоге.

aws ds-data describe-user command-name \
    --directory-id d-1234567890 \
    --sam-account-name 'john.doe'

Вывод:

{
    "DirectoryId": "d-1234567890",
    "DistinguishedName": "CN=john.doe,OU=Users,OU=CORP,DC=corp,DC=example,DC=com",
    "Enabled": false,
    "Realm": "corp.example.com",
    "SAMAccountName": "john.doe",
    "SID": "S-1-2-34-5678901234-5678901234-5678910123-4567",
    "UserPrincipalName": "john.doe@CORP.EXAMPLE.COM"
}

Для получения дополнительной информации см. раздел Просмотр и обновление пользователя AWS Managed Microsoft AD в руководстве по администрированию службы каталогов AWS.

Вывод

DirectoryId -> (строка)

Идентификатор (ID) каталога, связанного с пользователем.

DistinguishedName -> (строка)

Выделенное имя объекта.

EmailAddress -> (строка)

Адрес электронной почты пользователя.

Enabled -> (булево)

Указывает, активен ли учётная запись пользователя.

GivenName -> (строка)

Имя пользователя.

OtherAttributes -> (массив)

Значения атрибутов, возвращаемые для имён атрибутов, включённых в запрос.

Примечание

Имена атрибутов не чувствительны к регистру.

ключ -> (строка)

значение -> (структура помеченного объединения)

Тип данных для атрибута. Каждое значение атрибута описывается как пара имя-значение. Имя — имя схемы AD, а значение — само значение. Список поддерживаемых атрибутов см. в разделе Атрибуты данных службы каталогов.

Примечание

Это структура помеченного объединения. Только один из следующих верхних ключей может быть установлен: BOOL, N, S, SS.

BOOL -> (булево)

Указывает, что значение типа атрибута — булево. Например:

"BOOL": true

N -> (длинное целое)

Указывает, что значение типа атрибута — число. Например:

"N": "16"

S -> (строка)

Указывает, что значение типа атрибута — строка. Например:

"S": "S Group"

SS -> (список)

Указывает, что значение типа атрибута — множество строк. Например:

"SS": ["sample_service_class/host.sample.com:1234/sample_service_name_1", "sample_service_class/host.sample.com:1234/sample_service_name_2"]

(строка)

Realm -> (строка)

Имя домена, связанное с пользователем.

SAMAccountName -> (строка)

Имя пользователя.

SID -> (строка)

Уникальный идентификатор безопасности (SID) пользователя.

Surname -> (строка)

Фамилия пользователя.

UserPrincipalName -> (строка)

UPN, представляющий собой имя входа в стиле Интернета для пользователя и основанный на стандарте Интернета RFC 822. UPN короче, чем выделенное имя, и его легче запомнить.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API