Authorization Server - Create Or Update

Service:

API Management

API Version:

2022-08-01

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=2022-08-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
authsid	path	True	string	Identificador do servidor de autorização. Regex pattern: ^[^*#&+:<>?]+$
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
serviceName	path	True	string	O nome do serviço Gerenciamento de API. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	A ID da assinatura de destino.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	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

Nome	Obrigatório	Tipo	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	GrantType[]	Forma de uma concessão de autorização, que o cliente usa para solicitar o token de acesso.
properties.authorizationMethods		AuthorizationMethod[]	Verbos HTTP compatíveis com o ponto de extremidade de autorização. GET deve estar sempre presente. POST é opcional.
properties.bearerTokenSendingMethods		BearerTokenSendingMethod[]	Especifica o mecanismo pelo qual o token de acesso é passado para a API.
properties.clientAuthenticationMethod		ClientAuthenticationMethod[]	Método de autenticação com suporte pelo ponto de extremidade do token desse servidor de autorização. Os valores possíveis são Básico e/ou Corpo. Quando Body é 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. Essa propriedade não será preenchida em 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		TokenBodyParameterContract[]	Parâmetros adicionais exigidos pelo ponto de extremidade de token desse servidor de autorização representado como uma matriz de objetos JSON com propriedades de cadeia de caracteres de nome e valor, ou seja, {"name" : "name value", "value": "a value"}.
properties.tokenEndpoint		string	Ponto de extremidade do token OAuth. Contém o URI absoluto para a entidade referenciada.
properties.useInApiDocumentation		boolean	Se for true, o servidor de autorização será usado na documentação da API no portal do desenvolvedor. False por padrão se nenhum valor for fornecido.
properties.useInTestConsole		boolean	Se for true, o servidor de autorização poderá ser usado no console de teste do portal do desenvolvedor. True por padrão se nenhum valor for fornecido.

Respostas

Nome	Tipo	Description
200 OK	AuthorizationServerContract	O servidor de autorização já está registrado. Headers ETag: string
201 Created	AuthorizationServerContract	O servidor de autorização foi registrado com êxito. Headers ETag: string
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

ApiManagementCreateAuthorizationServer

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer?api-version=2022-08-01

{
  "properties": {
    "displayName": "test2",
    "useInTestConsole": false,
    "useInApiDocumentation": true,
    "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"
  }
}

Java

import com.azure.resourcemanager.apimanagement.models.AuthorizationMethod;
import com.azure.resourcemanager.apimanagement.models.BearerTokenSendingMethod;
import com.azure.resourcemanager.apimanagement.models.GrantType;
import java.util.Arrays;

/** Samples for AuthorizationServer CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateAuthorizationServer.json
     */
    /**
     * Sample code: ApiManagementCreateAuthorizationServer.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementCreateAuthorizationServer(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .authorizationServers()
            .define("newauthServer")
            .withExistingService("rg1", "apimService1")
            .withDisplayName("test2")
            .withUseInTestConsole(false)
            .withUseInApiDocumentation(true)
            .withClientRegistrationEndpoint("https://www.contoso.com/apps")
            .withAuthorizationEndpoint("https://www.contoso.com/oauth2/auth")
            .withGrantTypes(Arrays.asList(GrantType.AUTHORIZATION_CODE, GrantType.IMPLICIT))
            .withClientId("1")
            .withClientSecret("2")
            .withDescription("test server")
            .withAuthorizationMethods(Arrays.asList(AuthorizationMethod.GET))
            .withTokenEndpoint("https://www.contoso.com/oauth2/token")
            .withSupportState(true)
            .withDefaultScope("read write")
            .withBearerTokenSendingMethods(Arrays.asList(BearerTokenSendingMethod.AUTHORIZATION_HEADER))
            .withResourceOwnerUsername("un")
            .withResourceOwnerPassword("pwd")
            .create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_create_authorization_server.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.authorization_server.create_or_update(
        resource_group_name="rg1",
        service_name="apimService1",
        authsid="newauthServer",
        parameters={
            "properties": {
                "authorizationEndpoint": "https://www.contoso.com/oauth2/auth",
                "authorizationMethods": ["GET"],
                "bearerTokenSendingMethods": ["authorizationHeader"],
                "clientId": "1",
                "clientRegistrationEndpoint": "https://www.contoso.com/apps",
                "clientSecret": "2",
                "defaultScope": "read write",
                "description": "test server",
                "displayName": "test2",
                "grantTypes": ["authorizationCode", "implicit"],
                "resourceOwnerPassword": "pwd",
                "resourceOwnerUsername": "un",
                "supportState": True,
                "tokenEndpoint": "https://www.contoso.com/oauth2/token",
                "useInApiDocumentation": True,
                "useInTestConsole": False,
            }
        },
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateAuthorizationServer.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateAuthorizationServer.json
func ExampleAuthorizationServerClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAuthorizationServerClient().CreateOrUpdate(ctx, "rg1", "apimService1", "newauthServer", armapimanagement.AuthorizationServerContract{
		Properties: &armapimanagement.AuthorizationServerContractProperties{
			Description: to.Ptr("test server"),
			AuthorizationMethods: []*armapimanagement.AuthorizationMethod{
				to.Ptr(armapimanagement.AuthorizationMethodGET)},
			BearerTokenSendingMethods: []*armapimanagement.BearerTokenSendingMethod{
				to.Ptr(armapimanagement.BearerTokenSendingMethodAuthorizationHeader)},
			DefaultScope:               to.Ptr("read write"),
			ResourceOwnerPassword:      to.Ptr("pwd"),
			ResourceOwnerUsername:      to.Ptr("un"),
			SupportState:               to.Ptr(true),
			TokenEndpoint:              to.Ptr("https://www.contoso.com/oauth2/token"),
			AuthorizationEndpoint:      to.Ptr("https://www.contoso.com/oauth2/auth"),
			ClientID:                   to.Ptr("1"),
			ClientRegistrationEndpoint: to.Ptr("https://www.contoso.com/apps"),
			ClientSecret:               to.Ptr("2"),
			DisplayName:                to.Ptr("test2"),
			GrantTypes: []*armapimanagement.GrantType{
				to.Ptr(armapimanagement.GrantTypeAuthorizationCode),
				to.Ptr(armapimanagement.GrantTypeImplicit)},
			UseInAPIDocumentation: to.Ptr(true),
			UseInTestConsole:      to.Ptr(false),
		},
	}, &armapimanagement.AuthorizationServerClientCreateOrUpdateOptions{IfMatch: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.AuthorizationServerContract = armapimanagement.AuthorizationServerContract{
	// 	Name: to.Ptr("newauthServer"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/authorizationServers"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer"),
	// 	Properties: &armapimanagement.AuthorizationServerContractProperties{
	// 		Description: to.Ptr("test server"),
	// 		AuthorizationMethods: []*armapimanagement.AuthorizationMethod{
	// 			to.Ptr(armapimanagement.AuthorizationMethodGET)},
	// 			BearerTokenSendingMethods: []*armapimanagement.BearerTokenSendingMethod{
	// 				to.Ptr(armapimanagement.BearerTokenSendingMethodAuthorizationHeader)},
	// 				DefaultScope: to.Ptr("read write"),
	// 				ResourceOwnerPassword: to.Ptr("pwd"),
	// 				ResourceOwnerUsername: to.Ptr("un"),
	// 				SupportState: to.Ptr(true),
	// 				TokenEndpoint: to.Ptr("https://www.contoso.com/oauth2/token"),
	// 				AuthorizationEndpoint: to.Ptr("https://www.contoso.com/oauth2/auth"),
	// 				ClientID: to.Ptr("1"),
	// 				ClientRegistrationEndpoint: to.Ptr("https://www.contoso.com/apps"),
	// 				DisplayName: to.Ptr("test2"),
	// 				GrantTypes: []*armapimanagement.GrantType{
	// 					to.Ptr(armapimanagement.GrantTypeAuthorizationCode),
	// 					to.Ptr(armapimanagement.GrantTypeImplicit)},
	// 					UseInAPIDocumentation: to.Ptr(true),
	// 					UseInTestConsole: to.Ptr(false),
	// 				},
	// 			}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates new authorization server or updates an existing authorization server.
 *
 * @summary Creates new authorization server or updates an existing authorization server.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateAuthorizationServer.json
 */
async function apiManagementCreateAuthorizationServer() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const authsid = "newauthServer";
  const parameters = {
    description: "test server",
    authorizationEndpoint: "https://www.contoso.com/oauth2/auth",
    authorizationMethods: ["GET"],
    bearerTokenSendingMethods: ["authorizationHeader"],
    clientId: "1",
    clientRegistrationEndpoint: "https://www.contoso.com/apps",
    clientSecret: "2",
    defaultScope: "read write",
    displayName: "test2",
    grantTypes: ["authorizationCode", "implicit"],
    resourceOwnerPassword: "pwd",
    resourceOwnerUsername: "un",
    supportState: true,
    tokenEndpoint: "https://www.contoso.com/oauth2/token",
    useInApiDocumentation: true,
    useInTestConsole: false,
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.authorizationServer.createOrUpdate(
    resourceGroupName,
    serviceName,
    authsid,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer",
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "name": "newauthServer",
  "properties": {
    "displayName": "test2",
    "useInTestConsole": false,
    "useInApiDocumentation": true,
    "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"
  }
}

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer",
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "name": "newauthServer",
  "properties": {
    "displayName": "test2",
    "useInTestConsole": false,
    "useInApiDocumentation": true,
    "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

Nome	Description
AuthorizationMethod	Verbos HTTP compatíveis com o ponto de extremidade de autorização. GET deve estar sempre presente. POST é opcional.
AuthorizationServerContract	Configurações externas do servidor de autorização OAuth.
BearerTokenSendingMethod	Especifica o mecanismo pelo qual o token de acesso é passado para a API.
ClientAuthenticationMethod	Método de autenticação com suporte pelo ponto de extremidade do token desse servidor de autorização. Os valores possíveis são Básico e/ou Corpo. Quando Body é 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.
ErrorFieldContract	Contrato de campo de erro.
ErrorResponse	Resposta de erro.
GrantType	Forma de uma concessão de autorização, que o cliente usa para solicitar o token de acesso.
TokenBodyParameterContract	OAuth adquire o parâmetro do corpo da solicitação de token (www-url-form-encoded).

AuthorizationMethod

Verbos HTTP compatíveis com o ponto de extremidade de autorização. GET deve estar sempre presente. POST é opcional.

Nome	Tipo	Description
DELETE	string
GET	string
HEAD	string
OPTIONS	string
PATCH	string
POST	string
PUT	string
TRACE	string

AuthorizationServerContract

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

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O 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	AuthorizationMethod[]	Verbos HTTP compatíveis com o ponto de extremidade de autorização. GET deve estar sempre presente. POST é opcional.
properties.bearerTokenSendingMethods	BearerTokenSendingMethod[]	Especifica o mecanismo pelo qual o token de acesso é passado para a API.
properties.clientAuthenticationMethod	ClientAuthenticationMethod[]	Método de autenticação com suporte pelo ponto de extremidade do token desse servidor de autorização. Os valores possíveis são Básico e/ou Corpo. Quando Body é 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. Essa propriedade não será preenchida em 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	GrantType[]	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	TokenBodyParameterContract[]	Parâmetros adicionais exigidos pelo ponto de extremidade de token desse servidor de autorização representado como uma matriz de objetos JSON com propriedades de cadeia de caracteres de nome e valor, ou seja, {"name" : "name value", "value": "a value"}.
properties.tokenEndpoint	string	Ponto de extremidade do token OAuth. Contém o URI absoluto para a entidade referenciada.
properties.useInApiDocumentation	boolean	Se for true, o servidor de autorização será usado na documentação da API no portal do desenvolvedor. False por padrão se nenhum valor for fornecido.
properties.useInTestConsole	boolean	Se for true, o servidor de autorização poderá ser usado no console de teste do portal do desenvolvedor. True por padrão se nenhum valor for fornecido.
type	string	Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

BearerTokenSendingMethod

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

Nome	Tipo	Description
authorizationHeader	string
query	string

ClientAuthenticationMethod

Método de autenticação com suporte pelo ponto de extremidade do token desse servidor de autorização. Os valores possíveis são Básico e/ou Corpo. Quando Body é 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.

Nome	Tipo	Description
Basic	string	Método básico de Autenticação de Cliente.
Body	string	Método de autenticação baseada em corpo.

ErrorFieldContract

Contrato de campo de erro.

Nome	Tipo	Description
code	string	Código de erro no nível da propriedade.
message	string	Representação legível por humanos do erro no nível da propriedade.
target	string	Nome da propriedade.

ErrorResponse

Resposta de erro.

Nome	Tipo	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	ErrorFieldContract[]	A lista de campos inválidos enviados na solicitação, em caso de erro de validação.
error.message	string	Representação legível ao olho humano do erro.

GrantType

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

Nome	Tipo	Description
authorizationCode	string	Fluxo de concessão de código de autorização, conforme descrito https://tools.ietf.org/html/rfc6749#section-4.1.
clientCredentials	string	Fluxo de concessão de credenciais do cliente, conforme descrito https://tools.ietf.org/html/rfc6749#section-4.4.
implicit	string	Fluxo de concessão de código implícito, conforme descrito https://tools.ietf.org/html/rfc6749#section-4.2.
resourceOwnerPassword	string	Fluxo de concessão de senha do proprietário do recurso, conforme descrito https://tools.ietf.org/html/rfc6749#section-4.3.

TokenBodyParameterContract

OAuth adquire o parâmetro do corpo da solicitação de token (www-url-form-encoded).

Nome	Tipo	Description
name	string	nome do parâmetro body.
value	string	valor do parâmetro body.