[ aws . cognito-idp ]
создать-сервер-ресурсов
Описание
Создаёт новый сервер ресурсов OAuth2.0 и определяет в нём пользовательские области. Серверы ресурсов связаны с пользовательскими областями и авторизацией «машина-машина» (M2M). Дополнительную информацию см. в разделе Управление доступом с помощью серверов ресурсов.
Примечание
Amazon Cognito оценивает политики управления идентификацией и доступом (IAM) в запросах для этой операции API. Для этой операции необходимо использовать учетные данные IAM для авторизации запросов и предоставить себе соответствующее разрешение IAM в политике.
- Подписание запросов к API Amazon Web Services
- Использование API пулов пользователей Amazon Cognito и конечных точек пулов пользователей
См. также: Документация API AWS
Синтаксис
create-resource-server
--user-pool-id <value>
--identifier <value>
--name <value>
[--scopes <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]
Параметры
--user-pool-id (строка)
--identifier (строка)
Уникальный идентификатор сервера ресурсов для сервера ресурсов. Идентификатор может быть дружественным для API именем, например, solar-system-data. Также можно задать URL API, например, https://solar-system-data-api.example.com, в качестве идентификатора.
Amazon Cognito отображает области в токенах доступа в формате $resource-server-identifier/$scope. Более длинные строки идентификаторов областей увеличивают размер токенов доступа.
--name (строка)
--scopes (список)
Список пользовательских областей. Каждая область — это карта ключ-значение с ключами ScopeName и ScopeDescription. Название пользовательской области — это сочетание ScopeName и идентификатора сервера ресурсов в этом запросе, например, MyResourceServerName/MyScopeName.
(структура)
Одна пользовательская область, связанная с сервером ресурсов пула пользователей. Этот тип данных является членом ResourceServerScopeType. Дополнительную информацию см. в разделе Области, M2M и авторизация API с помощью серверов ресурсов.
ScopeName -> (строка)
resourceServerIdentifier/ScopeName. Например, если этот параметр равен exampleScope на сервере ресурсов с идентификатором exampleResourceServer, вы запрашиваете и получаете область exampleResourceServer/exampleScope.ScopeDescription -> (строка)
Сокращённый синтаксис:
ScopeName=string,ScopeDescription=string ...
Синтаксис JSON:
[
{
"ScopeName": "string",
"ScopeDescription": "string"
}
...
]
--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, 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.
Для создания клиента пула пользователей
Следующий пример create-resource-server создаёт новый сервер ресурсов с пользовательскими областями.
aws cognito-idp create-resource-server \
--user-pool-id us-west-2_EXAMPLE \
--identifier solar-system-data \
--name "Solar system object tracker" \
--scopes ScopeName=sunproximity.read,ScopeDescription="Distance in AU from Sol" ScopeName=asteroids.add,ScopeDescription="Enter a new asteroid"
Вывод:
{
"ResourceServer": {
"UserPoolId": "us-west-2_EXAMPLE",
"Identifier": "solar-system-data",
"Name": "Solar system object tracker",
"Scopes": [
{
"ScopeName": "sunproximity.read",
"ScopeDescription": "Distance in AU from Sol"
},
{
"ScopeName": "asteroids.add",
"ScopeDescription": "Enter a new asteroid"
}
]
}
}
Дополнительную информацию см. в разделе «Области, M2M и API с серверами ресурсов» в руководстве разработчика Amazon Cognito.
Вывод
ResourceServer -> (структура)
Подробная информация о новом сервере ресурсов.
UserPoolId -> (строка)
Identifier -> (строка)
Уникальный идентификатор сервера ресурсов для сервера ресурсов. Идентификатор может быть дружественным для API именем, например, solar-system-data. Также можно задать URL API, например, https://solar-system-data-api.example.com, в качестве идентификатора.
Amazon Cognito отображает области в токенах доступа в формате $resource-server-identifier/$scope. Более длинные строки идентификаторов областей увеличивают размер токенов доступа.
Name -> (строка)
Scopes -> (список)
Список областей, определённых для сервера ресурсов.
(структура)
Одна пользовательская область, связанная с сервером ресурсов пула пользователей. Этот тип данных является членом ResourceServerScopeType. Дополнительную информацию см. в разделе Области, M2M и авторизация API с помощью серверов ресурсов.
ScopeName -> (строка)
resourceServerIdentifier/ScopeName. Например, если этот параметр равен exampleScope на сервере ресурсов с идентификатором exampleResourceServer, вы запрашиваете и получаете область exampleResourceServer/exampleScope.ScopeDescription -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.