Authorization Server - Create Or Update

Cria ou atualiza um servidor de autorização.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers/{authsid}?api-version=2021-01-01-preview

Parâmetros de URI

Name In Required Type Description
authsid
path True
  • string

Identificador do servidor de autorização.

Regex pattern: ^[^*#&+:<>?]+$

resourceGroupName
path True
  • string

O nome do grupo de recursos.

serviceName
path True
  • string

O nome do serviço de gerenciamento de API.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Credenciais de assinatura que identificam exclusivamente Microsoft Azure assinatura. A ID da assinatura faz parte do URI para cada chamada de serviço.

api-version
query True
  • string

Versão da API a ser usada com a solicitação do cliente.

Cabeçalho da solicitação

Name Required Type Description
If-Match
  • string

ETag da entidade. Não é necessário ao criar uma entidade, mas é necessário ao atualizar uma entidade.

Corpo da solicitação

Name Required Type Description
properties.authorizationEndpoint True
  • string

Ponto de extremidade de autorização OAuth. Consulte http://tools.ietf.org/html/rfc6749#section-3.2.

properties.clientId True
  • string

ID do cliente ou do aplicativo registrado com esse servidor de autorização.

properties.clientRegistrationEndpoint True
  • string

Referência opcional para uma página em que o registro de cliente ou aplicativo para esse servidor de autorização é executado. Contém a URL absoluta para a entidade referenciada.

properties.displayName True
  • string

Nome do servidor de autorização amigável.

properties.grantTypes True
  • string[]

Forma de uma concessão de autorização, que o cliente usa para solicitar o token de acesso.

properties.authorizationMethods
  • string[]

Verbos HTTP com suporte do ponto de extremidade de autorização. GET deve estar sempre presente. POST é opcional.

properties.bearerTokenSendingMethods
  • string[]

Especifica o mecanismo pelo qual o token de acesso é passado para a API.

properties.clientAuthenticationMethod
  • string[]

Método de autenticação com suporte pelo ponto de extremidade do token desse servidor de autorização. Os valores possíveis são Basic e/ou Body. Quando o corpo é especificado, as credenciais do cliente e outros parâmetros são passados dentro do corpo da solicitação no formato application/x-www-form-urlencoded.

properties.clientSecret
  • string

Segredo do cliente ou do aplicativo registrado com esse servidor de autorização. Esta propriedade não será preenchida nas operações ' GET '! Use a solicitação POST '/listSecrets ' para obter o valor.

properties.defaultScope
  • string

Escopo do token de acesso que vai ser solicitado por padrão. Pode ser substituído no nível da API. Deve ser fornecido na forma de uma cadeia de caracteres que contém valores delimitados por espaço.

properties.description
  • string

Descrição do servidor de autorização. Pode conter marcas de formatação HTML.

properties.resourceOwnerPassword
  • string

Pode, opcionalmente, ser especificado quando o tipo de concessão de senha de proprietário do recurso é compatível com esse servidor de autorização. Senha do proprietário do recurso padrão.

properties.resourceOwnerUsername
  • string

Pode, opcionalmente, ser especificado quando o tipo de concessão de senha de proprietário do recurso é compatível com esse servidor de autorização. Nome de usuário do proprietário do recurso padrão.

properties.supportState
  • boolean

Se for true, o servidor de autorização incluirá o parâmetro de estado da solicitação de autorização para sua resposta. O cliente pode usar o parâmetro de estado para aumentar a segurança de protocolo.

properties.tokenBodyParameters

Parâmetros adicionais exigidos pelo ponto de extremidade do token desse servidor de autorização representados como uma matriz de objetos JSON com propriedades de cadeia de caracteres de nome e valor, ou seja, {"Name": "nome-de-valor", "valor": "um valor"}.

properties.tokenEndpoint
  • string

Ponto de extremidade do token OAuth. Contém o URI absoluto para a entidade referenciada.

Respostas

Name Type Description
200 OK

O servidor de autorização já está registrado.

Headers

  • ETag: string
201 Created

O servidor de autorização foi registrado com êxito.

Headers

  • ETag: string
Other Status Codes

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo de OAuth2 de Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation representar sua conta de usuário

Exemplos

ApiManagementCreateAuthorizationServer

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer?api-version=2021-01-01-preview
{
  "properties": {
    "displayName": "test2",
    "description": "test server",
    "clientRegistrationEndpoint": "https://www.contoso.com/apps",
    "authorizationEndpoint": "https://www.contoso.com/oauth2/auth",
    "authorizationMethods": [
      "GET"
    ],
    "tokenEndpoint": "https://www.contoso.com/oauth2/token",
    "supportState": true,
    "defaultScope": "read write",
    "grantTypes": [
      "authorizationCode",
      "implicit"
    ],
    "bearerTokenSendingMethods": [
      "authorizationHeader"
    ],
    "clientId": "1",
    "clientSecret": "2",
    "resourceOwnerUsername": "un",
    "resourceOwnerPassword": "pwd"
  }
}

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer",
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "name": "newauthServer",
  "properties": {
    "displayName": "test2",
    "description": "test server",
    "clientRegistrationEndpoint": "https://www.contoso.com/apps",
    "authorizationEndpoint": "https://www.contoso.com/oauth2/auth",
    "authorizationMethods": [
      "GET"
    ],
    "tokenEndpoint": "https://www.contoso.com/oauth2/token",
    "supportState": true,
    "defaultScope": "read write",
    "grantTypes": [
      "authorizationCode",
      "implicit"
    ],
    "bearerTokenSendingMethods": [
      "authorizationHeader"
    ],
    "clientId": "1",
    "resourceOwnerUsername": "un",
    "resourceOwnerPassword": "pwd"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer",
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "name": "newauthServer",
  "properties": {
    "displayName": "test2",
    "description": "test server",
    "clientRegistrationEndpoint": "https://www.contoso.com/apps",
    "authorizationEndpoint": "https://www.contoso.com/oauth2/auth",
    "authorizationMethods": [
      "GET"
    ],
    "tokenEndpoint": "https://www.contoso.com/oauth2/token",
    "supportState": true,
    "defaultScope": "read write",
    "grantTypes": [
      "authorizationCode",
      "implicit"
    ],
    "bearerTokenSendingMethods": [
      "authorizationHeader"
    ],
    "clientId": "1",
    "resourceOwnerUsername": "un",
    "resourceOwnerPassword": "pwd"
  }
}

Definições

AuthorizationServerContract

Configurações do servidor de autorização OAuth externa.

ErrorFieldContract

Contrato de campo de erro.

ErrorResponse

Resposta de erro.

TokenBodyParameterContract

Parâmetro de corpo de solicitação de token de aquisição OAuth (www-URL-Form-encoded).

AuthorizationServerContract

Configurações do servidor de autorização OAuth externa.

Name Type Description
id
  • string

ID do recurso.

name
  • string

Nome do recurso.

properties.authorizationEndpoint
  • string

Ponto de extremidade de autorização OAuth. Consulte http://tools.ietf.org/html/rfc6749#section-3.2.

properties.authorizationMethods
  • string[]

Verbos HTTP com suporte do ponto de extremidade de autorização. GET deve estar sempre presente. POST é opcional.

properties.bearerTokenSendingMethods
  • string[]

Especifica o mecanismo pelo qual o token de acesso é passado para a API.

properties.clientAuthenticationMethod
  • string[]

Método de autenticação com suporte pelo ponto de extremidade do token desse servidor de autorização. Os valores possíveis são Basic e/ou Body. Quando o corpo é especificado, as credenciais do cliente e outros parâmetros são passados dentro do corpo da solicitação no formato application/x-www-form-urlencoded.

properties.clientId
  • string

ID do cliente ou do aplicativo registrado com esse servidor de autorização.

properties.clientRegistrationEndpoint
  • string

Referência opcional para uma página em que o registro de cliente ou aplicativo para esse servidor de autorização é executado. Contém a URL absoluta para a entidade referenciada.

properties.clientSecret
  • string

Segredo do cliente ou do aplicativo registrado com esse servidor de autorização. Esta propriedade não será preenchida nas operações ' GET '! Use a solicitação POST '/listSecrets ' para obter o valor.

properties.defaultScope
  • string

Escopo do token de acesso que vai ser solicitado por padrão. Pode ser substituído no nível da API. Deve ser fornecido na forma de uma cadeia de caracteres que contém valores delimitados por espaço.

properties.description
  • string

Descrição do servidor de autorização. Pode conter marcas de formatação HTML.

properties.displayName
  • string

Nome do servidor de autorização amigável.

properties.grantTypes
  • string[]

Forma de uma concessão de autorização, que o cliente usa para solicitar o token de acesso.

properties.resourceOwnerPassword
  • string

Pode, opcionalmente, ser especificado quando o tipo de concessão de senha de proprietário do recurso é compatível com esse servidor de autorização. Senha do proprietário do recurso padrão.

properties.resourceOwnerUsername
  • string

Pode, opcionalmente, ser especificado quando o tipo de concessão de senha de proprietário do recurso é compatível com esse servidor de autorização. Nome de usuário do proprietário do recurso padrão.

properties.supportState
  • boolean

Se for true, o servidor de autorização incluirá o parâmetro de estado da solicitação de autorização para sua resposta. O cliente pode usar o parâmetro de estado para aumentar a segurança de protocolo.

properties.tokenBodyParameters

Parâmetros adicionais exigidos pelo ponto de extremidade do token desse servidor de autorização representados como uma matriz de objetos JSON com propriedades de cadeia de caracteres de nome e valor, ou seja, {"Name": "nome-de-valor", "valor": "um valor"}.

properties.tokenEndpoint
  • string

Ponto de extremidade do token OAuth. Contém o URI absoluto para a entidade referenciada.

type
  • string

Tipo de recurso para o recurso de gerenciamento de API.

ErrorFieldContract

Contrato de campo de erro.

Name Type Description
code
  • string

Código de erro no nível da propriedade.

message
  • string

Representação legível do erro no nível da propriedade.

target
  • string

Nome da propriedade.

ErrorResponse

Resposta de erro.

Name Type Description
error.code
  • string

Código de erro definido pelo serviço. Esse código atua como um substatus do código de erro HTTP especificado na resposta.

error.details

A lista de campos inválidos enviar em solicitação, no caso de erro de validação.

error.message
  • string

Representação legível ao olho humano do erro.

TokenBodyParameterContract

Parâmetro de corpo de solicitação de token de aquisição OAuth (www-URL-Form-encoded).

Name Type Description
name
  • string

nome do parâmetro de corpo.

value
  • string

valor do parâmetro de corpo.