User - Generate Sso Url

Ruft eine Umleitungs-URL mit einem Authentifizierungstoken zum Anmelden des angegebenen Benutzers beim Entwicklerportal ab

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
resourceGroupName
path True

string

Der Name der Ressourcengruppe.

serviceName
path True

string

Der Name des API Management-Diensts.

RegEx-Muster: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.

userId
path True

string

Benutzer-ID. Muss im aktuellen API Management Dienst instance eindeutig sein.

api-version
query True

string

Version der API, die mit der Clientanforderung verwendet werden soll.

Antworten

Name Typ Beschreibung
200 OK

GenerateSsoUrlResult

Der Antworttext enthält die URL für die einmalige Anmeldung.

Other Status Codes

ErrorResponse

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

ApiManagementUserGenerateSsoUrl

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
ErrorFieldContract

Fehlerfeldvertrag.

ErrorResponse

Fehlerantwort.

GenerateSsoUrlResult

Generieren von Antwortdetails zu SSO-URL-Vorgängen.

ErrorFieldContract

Fehlerfeldvertrag.

Name Typ Beschreibung
code

string

Fehlercode auf Eigenschaftsebene.

message

string

Für Menschen lesbare Darstellung eines Fehlers auf Eigenschaftsebene.

target

string

Der Eigenschaftsname.

ErrorResponse

Fehlerantwort.

Name Typ Beschreibung
error.code

string

Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode.

error.details

ErrorFieldContract[]

Die Liste der ungültigen Felder, die im Falle eines Überprüfungsfehlers gesendet werden.

error.message

string

Lesbare Darstellung des Fehlers.

GenerateSsoUrlResult

Generieren von Antwortdetails zu SSO-URL-Vorgängen.

Name Typ Beschreibung
value

string

Umleitungs-URL, die den Wert der SSO-URL enthält.