Authorization Server - Create Or Update

Cria um novo servidor de autorização ou atualiza um servidor de autorização existente.

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

Parâmetros do 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 Gestão da API.

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

subscriptionId
path True
  • string

Credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID de subscrição faz parte do URI para cada chamada de serviço.

api-version
query True
  • string

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

Cabeçalho do Pedido

Name Required Type Description
If-Match
  • string

ETag da Entidade. Não é necessário na criação de uma entidade, mas é necessário ao atualizar uma entidade.

Corpo do Pedido

Name Required Type Description
properties.authorizationEndpoint True
  • string

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

properties.clientId True
  • string

Identificação de cliente ou aplicação registada com este servidor de autorização.

properties.clientRegistrationEndpoint True
  • string

Referência opcional a uma página onde o registo de clientes ou aplicativos para este servidor de autorização é realizado. Contém URL absoluto para entidade sendo referenciada.

properties.displayName True
  • string

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

properties.grantTypes True
  • string[]

Forma de um subsídio de autorização, que o cliente usa para solicitar o token de acesso.

properties.authorizationMethods
  • string[]

Verbos HTTP suportados pelo ponto final 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 suportado pelo ponto final simbólico deste servidor de autorização. Os valores possíveis são Básicos e/ou Corpo. Quando o Corpo é especificado, as credenciais do cliente e outros parâmetros são passados dentro do órgão de pedido no formato de aplicação/x-www-forma-urlencoded.

properties.clientSecret
  • string

Cliente ou app secret registado com este servidor de autorização. Esta propriedade não será preenchida em operações 'GET'! Utilize o pedido POST '/listSecrets' para obter o valor.

properties.defaultScope
  • string

Alcance de acesso ao símbolo que será solicitado por padrão. Pode ser ultrapassado ao nível da API. Deve ser fornecida sob a forma de uma cadeia que contenha valores delimitados pelo espaço.

properties.description
  • string

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

properties.resourceOwnerPassword
  • string

Pode ser especificado opcionalmente quando o tipo de concessão de senha do proprietário de recursos é suportado por este servidor de autorização. Senha do proprietário de recursos predefinido.

properties.resourceOwnerUsername
  • string

Pode ser especificado opcionalmente quando o tipo de concessão de senha do proprietário de recursos é suportado por este servidor de autorização. Nome de utilizador do proprietário de recursos predefinido.

properties.supportState
  • boolean

Se for verdade, o servidor de autorização incluirá o parâmetro do estado do pedido de autorização para a sua resposta. O cliente pode usar o parâmetro do Estado para aumentar a segurança do protocolo.

properties.tokenBodyParameters

Parâmetros adicionais exigidos pelo ponto final simbólico deste servidor de autorização representados como uma matriz de objetos JSON com propriedades de título e valor, ou seja, {"name" : "valor do nome", "valor": "um valor"}.

properties.tokenEndpoint
  • string

Ponto final simbólico OAuth. Contém URI absoluto à entidade sendo referenciada.

Respostas

Name Type Description
200 OK

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

Headers

  • ETag: string
201 Created

O servidor de autorização foi registado com sucesso.

Headers

  • ETag: string
Other Status Codes

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

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow.

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

Scopes

Name Description
user_impersonation personificar a sua conta de utilizador

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

Definições externas do servidor de autorização OAuth.

ErrorFieldContract

Contrato de Campo de Erro.

ErrorResponse

Resposta de erro.

TokenBodyParameterContract

A OAuth adquire o parâmetro do corpo do pedido simbólico (www-url-form-encoded).

AuthorizationServerContract

Definições externas do servidor de autorização OAuth.

Name Type Description
id
  • string

Identificação de recursos.

name
  • string

Nome de recurso.

properties.authorizationEndpoint
  • string

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

properties.authorizationMethods
  • string[]

Verbos HTTP suportados pelo ponto final 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 suportado pelo ponto final simbólico deste servidor de autorização. Os valores possíveis são Básicos e/ou Corpo. Quando o Corpo é especificado, as credenciais do cliente e outros parâmetros são passados dentro do órgão de pedido no formato de aplicação/x-www-forma-urlencoded.

properties.clientId
  • string

Identificação de cliente ou aplicação registada com este servidor de autorização.

properties.clientRegistrationEndpoint
  • string

Referência opcional a uma página onde o registo de clientes ou aplicativos para este servidor de autorização é realizado. Contém URL absoluto para entidade sendo referenciada.

properties.clientSecret
  • string

Cliente ou app secret registado com este servidor de autorização. Esta propriedade não será preenchida em operações 'GET'! Utilize o pedido POST '/listSecrets' para obter o valor.

properties.defaultScope
  • string

Alcance de acesso ao símbolo que será solicitado por padrão. Pode ser ultrapassado ao nível da API. Deve ser fornecida sob a forma de uma cadeia que contenha valores delimitados pelo espaço.

properties.description
  • string

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

properties.displayName
  • string

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

properties.grantTypes
  • string[]

Forma de um subsídio de autorização, que o cliente usa para solicitar o token de acesso.

properties.resourceOwnerPassword
  • string

Pode ser especificado opcionalmente quando o tipo de concessão de senha do proprietário de recursos é suportado por este servidor de autorização. Senha do proprietário de recursos predefinido.

properties.resourceOwnerUsername
  • string

Pode ser especificado opcionalmente quando o tipo de concessão de senha do proprietário de recursos é suportado por este servidor de autorização. Nome de utilizador do proprietário de recursos predefinido.

properties.supportState
  • boolean

Se for verdade, o servidor de autorização incluirá o parâmetro do estado do pedido de autorização para a sua resposta. O cliente pode usar o parâmetro do Estado para aumentar a segurança do protocolo.

properties.tokenBodyParameters

Parâmetros adicionais exigidos pelo ponto final simbólico deste servidor de autorização representados como uma matriz de objetos JSON com propriedades de título e valor, ou seja, {"name" : "valor do nome", "valor": "um valor"}.

properties.tokenEndpoint
  • string

Ponto final simbólico OAuth. Contém URI absoluto à entidade sendo referenciada.

type
  • string

Tipo de recurso para recurso de Gestão API.

ErrorFieldContract

Contrato de Campo de Erro.

Name Type Description
code
  • string

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

message
  • string

Representação legível pelo homem de erro de nível de propriedade.

target
  • string

Nome da propriedade.

ErrorResponse

Resposta de erro.

Name Type Description
error.code
  • string

Código de erro definido pelo serviço. Este código serve como sub-estado para o código de erro HTTP especificado na resposta.

error.details

A lista de campos inválidos envia a pedido, em caso de erro de validação.

error.message
  • string

Representação legível pelo erro.

TokenBodyParameterContract

A OAuth adquire o parâmetro do corpo do pedido simbólico (www-url-form-encoded).

Name Type Description
name
  • string

nome do parâmetro do corpo.

value
  • string

valor do parâmetro do corpo.