Authorization Server - Update
Обновляет сведения сервера авторизации, указанного его идентификатором.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers/{authsid}?api-version=2021-08-01
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
authsid
|
path | True |
string minLength: 1maxLength: 80 pattern: ^[^*#&+:<>?]+$ |
Идентификатор сервера авторизации. |
resource
|
path | True |
string |
Имя группы ресурсов. |
service
|
path | True |
string minLength: 1maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ |
Имя службы управления API. |
subscription
|
path | True |
string |
Учетные данные подписки, которые однозначно определяют подписку Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы. |
api-version
|
query | True |
string |
Версия API для использования с клиентским запросом. |
Заголовок запроса
Имя | Обязательно | Тип | Описание |
---|---|---|---|
If-Match | True |
string |
ETag сущности. ETag должен соответствовать текущему состоянию сущности из ответа заголовка запроса GET или оно должно быть * для безусловного обновления. |
Текст запроса
Имя | Тип | Описание |
---|---|---|
properties.authorizationEndpoint |
string |
Конечная точка авторизации OAuth. См. http://tools.ietf.org/html/rfc6749#section-3.2. |
properties.authorizationMethods |
HTTP-команды, поддерживаемые конечной точкой авторизации. GET должен всегда присутствовать. POST является необязательным. |
|
properties.bearerTokenSendingMethods |
Указывает механизм, с помощью которого маркер доступа передается API. |
|
properties.clientAuthenticationMethod |
Метод проверки подлинности, поддерживаемый конечной точкой маркера этого сервера авторизации. Возможные значения: "Базовый" и (или) "Текст". При указании текста учетные данные клиента и другие параметры передаются в тексте запроса в формате application/x-www-form-urlencoded. |
|
properties.clientId |
string |
Идентификатор клиента или приложения, зарегистрированный на этом сервере авторизации. |
properties.clientRegistrationEndpoint |
string |
Необязательная ссылка на страницу, на которой выполняется регистрация клиента или приложения для этого сервера авторизации. Содержит абсолютный URL-адрес для ссылки на сущность. |
properties.clientSecret |
string |
Секрет клиента или приложения, зарегистрированный на этом сервере авторизации. Это свойство не будет заполнено в операциях GET! Используйте запрос POST "/listSecrets", чтобы получить это значение. |
properties.defaultScope |
string |
Область маркера доступа, запрашиваемая по умолчанию. Можно переопределить на уровне API. Следует указать в виде строки, содержащей значения с разделителями пространства. |
properties.description |
string |
Описание сервера авторизации. Может содержать теги форматирования HTML. |
properties.displayName |
string minLength: 1maxLength: 50 |
Понятное имя сервера авторизации. |
properties.grantTypes |
Форма предоставления авторизации, которую клиент использует для запроса маркера доступа. |
|
properties.resourceOwnerPassword |
string |
При необходимости можно указать, когда тип предоставления пароля владельца ресурса поддерживается этим сервером авторизации. Пароль владельца ресурса по умолчанию. |
properties.resourceOwnerUsername |
string |
При необходимости можно указать, когда тип предоставления пароля владельца ресурса поддерживается этим сервером авторизации. Имя пользователя владельца ресурса по умолчанию. |
properties.supportState |
boolean |
Если задано значение true, сервер авторизации будет включать параметр состояния из запроса авторизации в ответ. Клиент может использовать параметр состояния для повышения безопасности протокола. |
properties.tokenBodyParameters |
Дополнительные параметры, необходимые конечной точке маркера этого сервера авторизации, представленного в виде массива объектов JSON со свойствами строки имени и значения, т. е. {"name" : "name value", "value": "a value"}. |
|
properties.tokenEndpoint |
string |
Конечная точка маркера OAuth. Содержит абсолютный универсальный код ресурса (URI) для объекта, на который ссылается ссылка. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Параметры сервера авторизации были успешно обновлены. Заголовки ETag: string |
|
Other Status Codes |
Ответ на ошибку, описывающий причину сбоя операции. |
Безопасность
azure_auth
Поток OAuth2 Azure Active Directory.
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
Имя | Описание |
---|---|
user_impersonation | олицетворения учетной записи пользователя |
Примеры
ApiManagementUpdateAuthorizationServer
Образец запроса
Пример ответа
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer",
"type": "Microsoft.ApiManagement/service/authorizationServers",
"name": "newauthServer",
"properties": {
"displayName": "test3",
"description": "test server",
"clientRegistrationEndpoint": "https://www.contoso.com/apps",
"authorizationEndpoint": "https://www.contoso.com/oauth2/auth",
"authorizationMethods": [
"GET"
],
"clientAuthenticationMethod": [
"Basic"
],
"tokenEndpoint": "https://www.contoso.com/oauth2/token",
"supportState": true,
"defaultScope": "read write",
"grantTypes": [
"authorizationCode",
"implicit"
],
"bearerTokenSendingMethods": [
"authorizationHeader"
],
"clientId": "updated",
"resourceOwnerUsername": "un",
"resourceOwnerPassword": "pwd"
}
}
Определения
Имя | Описание |
---|---|
Authorization |
HTTP-команды, поддерживаемые конечной точкой авторизации. GET должен всегда присутствовать. POST является необязательным. |
Authorization |
Параметры внешнего сервера авторизации OAuth. |
Authorization |
Параметры внешнего сервера авторизации OAuth. |
Bearer |
Указывает механизм, с помощью которого маркер доступа передается API. |
Client |
Метод проверки подлинности, поддерживаемый конечной точкой маркера этого сервера авторизации. Возможные значения: "Базовый" и (или) "Текст". При указании текста учетные данные клиента и другие параметры передаются в тексте запроса в формате application/x-www-form-urlencoded. |
Error |
Контракт поля ошибки. |
Error |
Ответ на ошибку. |
Grant |
Форма предоставления авторизации, которую клиент использует для запроса маркера доступа. |
Token |
Параметр текста запроса маркера OAuth (закодированный www-url-form-encoded). |
AuthorizationMethod
HTTP-команды, поддерживаемые конечной точкой авторизации. GET должен всегда присутствовать. POST является необязательным.
Значение | Описание |
---|---|
DELETE | |
GET | |
HEAD | |
OPTIONS | |
PATCH | |
POST | |
PUT | |
TRACE |
AuthorizationServerContract
Параметры внешнего сервера авторизации OAuth.
Имя | Тип | Описание |
---|---|---|
id |
string |
Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Имя ресурса |
properties.authorizationEndpoint |
string |
Конечная точка авторизации OAuth. См. http://tools.ietf.org/html/rfc6749#section-3.2. |
properties.authorizationMethods |
HTTP-команды, поддерживаемые конечной точкой авторизации. GET должен всегда присутствовать. POST является необязательным. |
|
properties.bearerTokenSendingMethods |
Указывает механизм, с помощью которого маркер доступа передается API. |
|
properties.clientAuthenticationMethod |
Метод проверки подлинности, поддерживаемый конечной точкой маркера этого сервера авторизации. Возможные значения: "Базовый" и (или) "Текст". При указании текста учетные данные клиента и другие параметры передаются в тексте запроса в формате application/x-www-form-urlencoded. |
|
properties.clientId |
string |
Идентификатор клиента или приложения, зарегистрированный на этом сервере авторизации. |
properties.clientRegistrationEndpoint |
string |
Необязательная ссылка на страницу, на которой выполняется регистрация клиента или приложения для этого сервера авторизации. Содержит абсолютный URL-адрес для ссылки на сущность. |
properties.clientSecret |
string |
Секрет клиента или приложения, зарегистрированный на этом сервере авторизации. Это свойство не будет заполнено в операциях GET! Используйте запрос POST "/listSecrets", чтобы получить это значение. |
properties.defaultScope |
string |
Область маркера доступа, запрашиваемая по умолчанию. Можно переопределить на уровне API. Следует указать в виде строки, содержащей значения с разделителями пространства. |
properties.description |
string |
Описание сервера авторизации. Может содержать теги форматирования HTML. |
properties.displayName |
string minLength: 1maxLength: 50 |
Понятное имя сервера авторизации. |
properties.grantTypes |
Форма предоставления авторизации, которую клиент использует для запроса маркера доступа. |
|
properties.resourceOwnerPassword |
string |
При необходимости можно указать, когда тип предоставления пароля владельца ресурса поддерживается этим сервером авторизации. Пароль владельца ресурса по умолчанию. |
properties.resourceOwnerUsername |
string |
При необходимости можно указать, когда тип предоставления пароля владельца ресурса поддерживается этим сервером авторизации. Имя пользователя владельца ресурса по умолчанию. |
properties.supportState |
boolean |
Если задано значение true, сервер авторизации будет включать параметр состояния из запроса авторизации в ответ. Клиент может использовать параметр состояния для повышения безопасности протокола. |
properties.tokenBodyParameters |
Дополнительные параметры, необходимые конечной точке маркера этого сервера авторизации, представленного в виде массива объектов JSON со свойствами строки имени и значения, т. е. {"name" : "name value", "value": "a value"}. |
|
properties.tokenEndpoint |
string |
Конечная точка маркера OAuth. Содержит абсолютный универсальный код ресурса (URI) для объекта, на который ссылается ссылка. |
type |
string |
Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts" |
AuthorizationServerUpdateContract
Параметры внешнего сервера авторизации OAuth.
Имя | Тип | Описание |
---|---|---|
id |
string |
Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Имя ресурса |
properties.authorizationEndpoint |
string |
Конечная точка авторизации OAuth. См. http://tools.ietf.org/html/rfc6749#section-3.2. |
properties.authorizationMethods |
HTTP-команды, поддерживаемые конечной точкой авторизации. GET должен всегда присутствовать. POST является необязательным. |
|
properties.bearerTokenSendingMethods |
Указывает механизм, с помощью которого маркер доступа передается API. |
|
properties.clientAuthenticationMethod |
Метод проверки подлинности, поддерживаемый конечной точкой маркера этого сервера авторизации. Возможные значения: "Базовый" и (или) "Текст". При указании текста учетные данные клиента и другие параметры передаются в тексте запроса в формате application/x-www-form-urlencoded. |
|
properties.clientId |
string |
Идентификатор клиента или приложения, зарегистрированный на этом сервере авторизации. |
properties.clientRegistrationEndpoint |
string |
Необязательная ссылка на страницу, на которой выполняется регистрация клиента или приложения для этого сервера авторизации. Содержит абсолютный URL-адрес для ссылки на сущность. |
properties.clientSecret |
string |
Секрет клиента или приложения, зарегистрированный на этом сервере авторизации. Это свойство не будет заполнено в операциях GET! Используйте запрос POST "/listSecrets", чтобы получить это значение. |
properties.defaultScope |
string |
Область маркера доступа, запрашиваемая по умолчанию. Можно переопределить на уровне API. Следует указать в виде строки, содержащей значения с разделителями пространства. |
properties.description |
string |
Описание сервера авторизации. Может содержать теги форматирования HTML. |
properties.displayName |
string minLength: 1maxLength: 50 |
Понятное имя сервера авторизации. |
properties.grantTypes |
Форма предоставления авторизации, которую клиент использует для запроса маркера доступа. |
|
properties.resourceOwnerPassword |
string |
При необходимости можно указать, когда тип предоставления пароля владельца ресурса поддерживается этим сервером авторизации. Пароль владельца ресурса по умолчанию. |
properties.resourceOwnerUsername |
string |
При необходимости можно указать, когда тип предоставления пароля владельца ресурса поддерживается этим сервером авторизации. Имя пользователя владельца ресурса по умолчанию. |
properties.supportState |
boolean |
Если задано значение true, сервер авторизации будет включать параметр состояния из запроса авторизации в ответ. Клиент может использовать параметр состояния для повышения безопасности протокола. |
properties.tokenBodyParameters |
Дополнительные параметры, необходимые конечной точке маркера этого сервера авторизации, представленного в виде массива объектов JSON со свойствами строки имени и значения, т. е. {"name" : "name value", "value": "a value"}. |
|
properties.tokenEndpoint |
string |
Конечная точка маркера OAuth. Содержит абсолютный универсальный код ресурса (URI) для объекта, на который ссылается ссылка. |
type |
string |
Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts" |
BearerTokenSendingMethod
Указывает механизм, с помощью которого маркер доступа передается API.
Значение | Описание |
---|---|
authorizationHeader | |
query |
ClientAuthenticationMethod
Метод проверки подлинности, поддерживаемый конечной точкой маркера этого сервера авторизации. Возможные значения: "Базовый" и (или) "Текст". При указании текста учетные данные клиента и другие параметры передаются в тексте запроса в формате application/x-www-form-urlencoded.
Значение | Описание |
---|---|
Basic |
Базовый метод проверки подлинности клиента. |
Body |
Метод проверки подлинности на основе тела. |
ErrorFieldContract
Контракт поля ошибки.
Имя | Тип | Описание |
---|---|---|
code |
string |
Код ошибки уровня свойств. |
message |
string |
Удобочитаемое пользователем представление ошибки уровня свойств. |
target |
string |
Имя свойства. |
ErrorResponse
Ответ на ошибку.
Имя | Тип | Описание |
---|---|---|
error.code |
string |
Код ошибки, определенный службой. Этот код служит вложенным состоянием для кода ошибки HTTP, указанного в ответе. |
error.details |
Список недопустимых полей, отправляемых в запросе, в случае ошибки проверки. |
|
error.message |
string |
Читаемое человеком представление ошибки. |
GrantType
Форма предоставления авторизации, которую клиент использует для запроса маркера доступа.
Значение | Описание |
---|---|
authorizationCode |
Поток предоставления кода авторизации, как описано https://tools.ietf.org/html/rfc6749#section-4.1. |
clientCredentials |
Поток предоставления учетных данных клиента, как описано https://tools.ietf.org/html/rfc6749#section-4.4. |
implicit |
Поток неявного предоставления кода, как описано https://tools.ietf.org/html/rfc6749#section-4.2. |
resourceOwnerPassword |
Поток предоставления пароля владельца ресурса, как описано https://tools.ietf.org/html/rfc6749#section-4.3. |
TokenBodyParameterContract
Параметр текста запроса маркера OAuth (закодированный www-url-form-encoded).
Имя | Тип | Описание |
---|---|---|
name |
string |
Имя параметра body. |
value |
string |
Значение параметра body. |