Partager via


User - Generate Sso Url

Récupère une URL de redirection contenant un jeton d’authentification pour connecter un utilisateur donné au portail des développeurs.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/generateSsoUrl?api-version=2021-08-01

Paramètres URI

Nom Dans Obligatoire Type Description
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.

userId
path True

string

Identificateur de l'utilisateur. Doit être unique dans le instance de service Gestion des API actuel.

api-version
query True

string

Version de l’API à utiliser avec la demande du client.

Réponses

Nom Type Description
200 OK

GenerateSsoUrlResult

Le corps de la réponse contient l'URL de connexion unique.

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

ApiManagementUserGenerateSsoUrl

Exemple de requête

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7/generateSsoUrl?api-version=2021-08-01

Exemple de réponse

{
  "value": "https://apimService1.portal.azure-api.net/signin-sso?token=57127d485157a511ace86ae7%26201706051624%267VY18MlwAom***********2bYr2bDQHg21OzQsNakExQ%3d%3d"
}

Définitions

Nom Description
ErrorFieldContract

Contrat de champ d’erreur.

ErrorResponse

Réponse d’erreur.

GenerateSsoUrlResult

Générer les détails de la réponse des opérations d’URL de l’authentification unique.

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.

GenerateSsoUrlResult

Générer les détails de la réponse des opérations d’URL de l’authentification unique.

Nom Type Description
value

string

Url de redirection contenant la valeur d’URL de l’authentification unique.