Partager via


Authorization Server - Update

Mises à jour les détails du serveur d’autorisation spécifiés par son identificateur.

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

Paramètres URI

Nom Dans Obligatoire Type Description
authsid
path True

string

Identificateur du serveur d’autorisation.

Modèle d’expression régulière: ^[^*#&+:<>?]+$

resourceGroupName
path True

string

Nom du groupe de ressources.

serviceName
path True

string

Nom du service Gestion des API.

Modèle d’expression régulière: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.

api-version
query True

string

Version de l’API à utiliser avec la demande cliente.

En-tête de la demande

Nom Obligatoire Type Description
If-Match True

string

ETag de l’entité. ETag doit correspondre à l’état d’entité actuel de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle.

Corps de la demande

Nom Type Description
properties.authorizationEndpoint

string

Point de terminaison d'autorisation OAuth. Consultez http://tools.ietf.org/html/rfc6749#section-3.2.

properties.authorizationMethods

AuthorizationMethod[]

Verbes HTTP pris en charge par le point de terminaison d’autorisation. GET doit toujours être présent. POST est facultatif.

properties.bearerTokenSendingMethods

BearerTokenSendingMethod[]

Spécifie le mécanisme par lequel le jeton d'accès est transmis à l'API.

properties.clientAuthenticationMethod

ClientAuthenticationMethod[]

Méthode d'authentification prise en charge par le point de terminaison de jeton de ce serveur d'autorisation. Les valeurs possibles sont Basic et/ou Body. Lorsque Body est spécifié, les informations d’identification du client et d’autres paramètres sont transmis dans le corps de la demande au format application/x-www-form-urlencoded.

properties.clientId

string

Id de client ou d'application inscrit auprès du serveur d'autorisation.

properties.clientRegistrationEndpoint

string

Référence facultative à une page où l'inscription du client ou de l'application pour ce serveur d'autorisation est effectuée. Contient l'URL absolue de l'entité référencée.

properties.clientSecret

string

Clé secrète de client ou d'application inscrite auprès du serveur d'autorisation. Cette propriété n’est pas renseignée sur les opérations « GET » ! Utilisez la requête POST « /listSecrets » pour obtenir la valeur.

properties.defaultScope

string

Étendue de jeton d'accès à demander par défaut. Peut être remplacée au niveau de l'API. Doit être fournie sous la forme d'une chaîne contenant des valeurs délimitées par des espaces.

properties.description

string

Description du serveur d'autorisation. Peut contenir des balises au format HTML.

properties.displayName

string

Nom du serveur d’autorisation convivial.

properties.grantTypes

GrantType[]

Forme d’octroi d’autorisation, que le client utilise pour demander le jeton d’accès.

properties.resourceOwnerPassword

string

Peut être spécifiée lorsque le type d'octroi de mot de passe de propriétaire de ressource est pris en charge par ce serveur d'autorisation. Mot de passe du propriétaire de ressource par défaut.

properties.resourceOwnerUsername

string

Peut être spécifiée lorsque le type d'octroi de mot de passe de propriétaire de ressource est pris en charge par ce serveur d'autorisation. Nom d'utilisateur du propriétaire de ressource par défaut.

properties.supportState

boolean

Si la valeur est true, le serveur d’autorisation inclut le paramètre d’état de la demande d’autorisation à sa réponse. Le client peut utiliser le paramètre d'état pour augmenter la sécurité du protocole.

properties.tokenBodyParameters

TokenBodyParameterContract[]

Paramètres supplémentaires requis par le point de terminaison de jeton de ce serveur d’autorisation représenté sous la forme d’un tableau d’objets JSON avec des propriétés de nom et de chaîne de valeur, à savoir {"name » : « name value », « value » : « a value"}.

properties.tokenEndpoint

string

Point de terminaison du jeton OAuth. Contient l'URI absolu de l'entité référencée.

Réponses

Nom Type Description
200 OK

AuthorizationServerContract

Les paramètres du serveur d'autorisation ont été correctement mis à jour.

En-têtes

ETag: string

Other Status Codes

ErrorResponse

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

ApiManagementUpdateAuthorizationServer

Exemple de requête

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


{
  "properties": {
    "clientId": "update",
    "clientSecret": "updated"
  }
}

Exemple de réponse

{
  "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"
  }
}

Définitions

Nom Description
AuthorizationMethod

Verbes HTTP pris en charge par le point de terminaison d’autorisation. GET doit toujours être présent. POST est facultatif.

AuthorizationServerContract

Paramètres du serveur d’autorisation OAuth externe.

AuthorizationServerUpdateContract

Paramètres du serveur d’autorisation OAuth externe.

BearerTokenSendingMethod

Spécifie le mécanisme par lequel le jeton d'accès est transmis à l'API.

ClientAuthenticationMethod

Méthode d'authentification prise en charge par le point de terminaison de jeton de ce serveur d'autorisation. Les valeurs possibles sont Basic et/ou Body. Lorsque Body est spécifié, les informations d’identification du client et d’autres paramètres sont passées dans le corps de la demande au format application/x-www-form-urlencoded.

ErrorFieldContract

Contrat de champ d’erreur.

ErrorResponse

Réponse d’erreur.

GrantType

Forme d’octroi d’autorisation, que le client utilise pour demander le jeton d’accès.

TokenBodyParameterContract

OAuth acquiert le paramètre de corps de la demande de jeton (www-url-form-encoded).

AuthorizationMethod

Verbes HTTP pris en charge par le point de terminaison d’autorisation. GET doit toujours être présent. POST est facultatif.

Nom Type Description
DELETE

string

GET

string

HEAD

string

OPTIONS

string

PATCH

string

POST

string

PUT

string

TRACE

string

AuthorizationServerContract

Paramètres du serveur d’autorisation OAuth externe.

Nom Type Description
id

string

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

nom de la ressource.

properties.authorizationEndpoint

string

Point de terminaison d'autorisation OAuth. Consultez http://tools.ietf.org/html/rfc6749#section-3.2.

properties.authorizationMethods

AuthorizationMethod[]

Verbes HTTP pris en charge par le point de terminaison d’autorisation. GET doit toujours être présent. POST est facultatif.

properties.bearerTokenSendingMethods

BearerTokenSendingMethod[]

Spécifie le mécanisme par lequel le jeton d'accès est transmis à l'API.

properties.clientAuthenticationMethod

ClientAuthenticationMethod[]

Méthode d'authentification prise en charge par le point de terminaison de jeton de ce serveur d'autorisation. Les valeurs possibles sont Basic et/ou Body. Lorsque Body est spécifié, les informations d’identification du client et d’autres paramètres sont passées dans le corps de la demande au format application/x-www-form-urlencoded.

properties.clientId

string

Id de client ou d'application inscrit auprès du serveur d'autorisation.

properties.clientRegistrationEndpoint

string

Référence facultative à une page où l'inscription du client ou de l'application pour ce serveur d'autorisation est effectuée. Contient l'URL absolue de l'entité référencée.

properties.clientSecret

string

Clé secrète de client ou d'application inscrite auprès du serveur d'autorisation. Cette propriété ne sera pas remplie sur les opérations « GET » ! Utilisez la requête POST « /listSecrets » pour obtenir la valeur.

properties.defaultScope

string

Étendue de jeton d'accès à demander par défaut. Peut être remplacée au niveau de l'API. Doit être fournie sous la forme d'une chaîne contenant des valeurs délimitées par des espaces.

properties.description

string

Description du serveur d'autorisation. Peut contenir des balises au format HTML.

properties.displayName

string

Nom du serveur d’autorisation convivial.

properties.grantTypes

GrantType[]

Forme d’octroi d’autorisation, que le client utilise pour demander le jeton d’accès.

properties.resourceOwnerPassword

string

Peut être spécifiée lorsque le type d'octroi de mot de passe de propriétaire de ressource est pris en charge par ce serveur d'autorisation. Mot de passe du propriétaire de ressource par défaut.

properties.resourceOwnerUsername

string

Peut être spécifiée lorsque le type d'octroi de mot de passe de propriétaire de ressource est pris en charge par ce serveur d'autorisation. Nom d'utilisateur du propriétaire de ressource par défaut.

properties.supportState

boolean

Si la valeur est true, le serveur d’autorisation inclut le paramètre d’état de la demande d’autorisation à sa réponse. Le client peut utiliser le paramètre d'état pour augmenter la sécurité du protocole.

properties.tokenBodyParameters

TokenBodyParameterContract[]

Paramètres supplémentaires requis par le point de terminaison de jeton de ce serveur d’autorisation représenté sous la forme d’un tableau d’objets JSON avec des propriétés de nom et de chaîne de valeur, c’est-à-dire {"name » : « name value », « value"}.

properties.tokenEndpoint

string

Point de terminaison du jeton OAuth. Contient l'URI absolu de l'entité référencée.

type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

AuthorizationServerUpdateContract

Paramètres du serveur d’autorisation OAuth externe.

Nom Type Description
id

string

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

nom de la ressource.

properties.authorizationEndpoint

string

Point de terminaison d'autorisation OAuth. Consultez http://tools.ietf.org/html/rfc6749#section-3.2.

properties.authorizationMethods

AuthorizationMethod[]

Verbes HTTP pris en charge par le point de terminaison d’autorisation. GET doit toujours être présent. POST est facultatif.

properties.bearerTokenSendingMethods

BearerTokenSendingMethod[]

Spécifie le mécanisme par lequel le jeton d'accès est transmis à l'API.

properties.clientAuthenticationMethod

ClientAuthenticationMethod[]

Méthode d'authentification prise en charge par le point de terminaison de jeton de ce serveur d'autorisation. Les valeurs possibles sont Basic et/ou Body. Lorsque Body est spécifié, les informations d’identification du client et d’autres paramètres sont passées dans le corps de la demande au format application/x-www-form-urlencoded.

properties.clientId

string

Id de client ou d'application inscrit auprès du serveur d'autorisation.

properties.clientRegistrationEndpoint

string

Référence facultative à une page où l'inscription du client ou de l'application pour ce serveur d'autorisation est effectuée. Contient l'URL absolue de l'entité référencée.

properties.clientSecret

string

Clé secrète de client ou d'application inscrite auprès du serveur d'autorisation. Cette propriété ne sera pas remplie sur les opérations « GET » ! Utilisez la requête POST « /listSecrets » pour obtenir la valeur.

properties.defaultScope

string

Étendue de jeton d'accès à demander par défaut. Peut être remplacée au niveau de l'API. Doit être fournie sous la forme d'une chaîne contenant des valeurs délimitées par des espaces.

properties.description

string

Description du serveur d'autorisation. Peut contenir des balises au format HTML.

properties.displayName

string

Nom du serveur d’autorisation convivial.

properties.grantTypes

GrantType[]

Forme d’octroi d’autorisation, que le client utilise pour demander le jeton d’accès.

properties.resourceOwnerPassword

string

Peut être spécifiée lorsque le type d'octroi de mot de passe de propriétaire de ressource est pris en charge par ce serveur d'autorisation. Mot de passe du propriétaire de ressource par défaut.

properties.resourceOwnerUsername

string

Peut être spécifiée lorsque le type d'octroi de mot de passe de propriétaire de ressource est pris en charge par ce serveur d'autorisation. Nom d'utilisateur du propriétaire de ressource par défaut.

properties.supportState

boolean

Si la valeur est true, le serveur d’autorisation inclut le paramètre d’état de la demande d’autorisation à sa réponse. Le client peut utiliser le paramètre d'état pour augmenter la sécurité du protocole.

properties.tokenBodyParameters

TokenBodyParameterContract[]

Paramètres supplémentaires requis par le point de terminaison de jeton de ce serveur d’autorisation représenté sous la forme d’un tableau d’objets JSON avec des propriétés de nom et de chaîne de valeur, c’est-à-dire {"name » : « name value », « value"}.

properties.tokenEndpoint

string

Point de terminaison du jeton OAuth. Contient l'URI absolu de l'entité référencée.

type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

BearerTokenSendingMethod

Spécifie le mécanisme par lequel le jeton d'accès est transmis à l'API.

Nom Type Description
authorizationHeader

string

query

string

ClientAuthenticationMethod

Méthode d'authentification prise en charge par le point de terminaison de jeton de ce serveur d'autorisation. Les valeurs possibles sont Basic et/ou Body. Lorsque Body est spécifié, les informations d’identification du client et d’autres paramètres sont passées dans le corps de la demande au format application/x-www-form-urlencoded.

Nom Type Description
Basic

string

Méthode d’authentification client de base.

Body

string

Méthode d’authentification basée sur le corps.

ErrorFieldContract

Contrat de champ d’erreur.

Nom Type Description
code

string

Code d'erreur de niveau propriété.

message

string

Représentation lisible par l’homme de l’erreur au niveau des propriétés.

target

string

Nom de propriété.

ErrorResponse

Réponse d’erreur.

Nom Type Description
error.code

string

Code d'erreur défini par le service. Ce code sert de sous-état pour le code d'erreur HTTP spécifié dans la réponse.

error.details

ErrorFieldContract[]

Liste des champs non valides envoyés dans la demande, en cas d’erreur de validation.

error.message

string

Représentation contrôlable de visu de l’erreur.

GrantType

Forme d’octroi d’autorisation, que le client utilise pour demander le jeton d’accès.

Nom Type Description
authorizationCode

string

Flux d’octroi de code d’autorisation comme décrit https://tools.ietf.org/html/rfc6749#section-4.1.

clientCredentials

string

Flux d’octroi des informations d’identification du client comme décrit https://tools.ietf.org/html/rfc6749#section-4.4.

implicit

string

Flux d’octroi de code implicite comme décrit https://tools.ietf.org/html/rfc6749#section-4.2.

resourceOwnerPassword

string

Flux d’octroi de mot de passe du propriétaire de la ressource, comme décrit https://tools.ietf.org/html/rfc6749#section-4.3.

TokenBodyParameterContract

OAuth acquiert le paramètre de corps de la demande de jeton (www-url-form-encoded).

Nom Type Description
name

string

nom du paramètre body.

value

string

valeur du paramètre body.